Module org.eclipse.persistence.jpa
Package org.eclipse.persistence.internal.jpa.querydef

Class CriteriaQueryImpl<T>

java.lang.Object
org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl<T>
org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl<T>
org.eclipse.persistence.internal.jpa.querydef.CriteriaQueryImpl<T>
All Implemented Interfaces:
AbstractQuery<T>, CommonAbstractCriteria, CriteriaQuery<T>, CriteriaSelect<T>, Serializable, CriteriaSelectInternal<T>
public class CriteriaQueryImpl<T> extends AbstractQueryImpl<T> implements CriteriaQuery<T>

Purpose: Contains the implementation of the CriteriaQuery interface of the JPA criteria API.

Description: This is the container class for the components that define a query.

Since:
EclipseLink 1.2
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • select

      public CriteriaQuery<T> select(Selection<? extends T> selection)
      Specified by:
      select in interface CriteriaQuery<T>

    • multiselect

      public CriteriaQuery<T> multiselect(Selection<?>... selections)
      Specify the items that are to be returned in the query result. Replaces the previously specified selection(s), if any.

      The type of the result of the query execution depends on the specification of the criteria query object as well as the arguments to the multiselect method as follows:

      If the type of the criteria query is CriteriaQuery<Tuple>, a Tuple object corresponding to the arguments of the multiselect method will be instantiated and returned for each row that results from the query execution.

      If the type of the criteria query is CriteriaQuery<X> for some user-defined class X, then the arguments to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. The IllegalStateException will be thrown if a constructor for the given argument types does not exist.

      If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the arguments of the multiselect method. The IllegalStateException will be thrown if the arguments to the multiselect method are not of type X.

      If the type of the criteria query is CriteriaQuery<Object>, and only a single argument is passed to the multiselect method, an instance of type Object will be returned for each row.

      If the type of the criteria query is CriteriaQuery<Object>, and more than one argument is passed to the multiselect method, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the arguments to the multiselect method.

      Specified by:
      multiselect in interface CriteriaQuery<T>
      Parameters:
      selections - expressions specifying the items that are to be returned in the query result
      Returns:
      the modified query

    • multiselect

      public CriteriaQuery<T> multiselect(List<Selection<?>> selectionList)
      Specify the items that are to be returned in the query result. Replaces the previously specified selection(s), if any.

      The type of the result of the query execution depends on the specification of the criteria query object as well as the arguments to the multiselect method as follows:

      If the type of the criteria query is CriteriaQuery<Tuple>, a Tuple object corresponding to the items in the selection list passed to the multiselect method will be instantiated and returned for each row that results from the query execution.

      If the type of the criteria query is CriteriaQuery<X> for some user-defined class X, then the items in the selection list passed to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. The IllegalStateException will be thrown if a constructor for the given argument types does not exist.

      If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the items in the selection list passed to the multiselect method. The IllegalStateException will be thrown if the elements in the selection list passed to the multiselect method are not of type X.

      If the type of the criteria query is CriteriaQuery<Object>, and the selection list passed to the multiselect method contains only a single item, an instance of type Object will be returned for each row.

      If the type of the criteria query is CriteriaQuery<Object>, and the selection list passed to the multiselect method contains more than one item, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the items in the selection list passed to the multiselect method.

      Specified by:
      multiselect in interface CriteriaQuery<T>
      Parameters:
      selectionList - list of expressions specifying the items that to be are returned in the query result
      Returns:
      the modified query

    • where

      public CriteriaQuery<T> where(Expression<Boolean> restriction)
      Description copied from class: AbstractQueryImpl
      Modify the query to restrict the query result according to the specified boolean expression. Replaces the previously added restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      where in interface AbstractQuery<T>
      Specified by:
      where in interface CriteriaQuery<T>
      Overrides:
      where in class AbstractQueryImpl<T>
      Parameters:
      restriction - a simple or compound boolean expression
      Returns:
      the modified query

    • where

      public CriteriaQuery<T> where(Predicate... restrictions)
      Description copied from class: AbstractQueryImpl
      Modify the query to restrict the query result according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      where in interface AbstractQuery<T>
      Specified by:
      where in interface CriteriaQuery<T>
      Overrides:
      where in class AbstractQueryImpl<T>
      Parameters:
      restrictions - zero or more restriction predicates
      Returns:
      the modified query

    • where

      public CriteriaQuery<T> where(List<Predicate> restrictions)
      Description copied from class: CommonAbstractCriteriaImpl
      Modify the query to restrict the query results according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.
      Specified by:
      where in interface AbstractQuery<T>
      Specified by:
      where in interface CriteriaQuery<T>
      Overrides:
      where in class AbstractQueryImpl<T>
      Parameters:
      restrictions - zero or more restriction predicates
      Returns:
      the modified query

    • groupBy

      public CriteriaQuery<T> groupBy(Expression<?>... grouping)
      Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      groupBy in interface AbstractQuery<T>
      Specified by:
      groupBy in interface CriteriaQuery<T>
      Overrides:
      groupBy in class AbstractQueryImpl<T>
      Parameters:
      grouping - zero or more grouping expressions
      Returns:
      the modified query

    • groupBy

      public CriteriaQuery<T> groupBy(List<Expression<?>> grouping)
      Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      groupBy in interface AbstractQuery<T>
      Specified by:
      groupBy in interface CriteriaQuery<T>
      Overrides:
      groupBy in class AbstractQueryImpl<T>
      Parameters:
      grouping - list of zero or more grouping expressions
      Returns:
      the modified query

    • having

      public CriteriaQuery<T> having(Expression<Boolean> restriction)
      Description copied from class: AbstractQueryImpl
      Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any.
      Specified by:
      having in interface AbstractQuery<T>
      Specified by:
      having in interface CriteriaQuery<T>
      Overrides:
      having in class AbstractQueryImpl<T>
      Parameters:
      restriction - a simple or compound boolean expression
      Returns:
      the modified query

    • having

      public CriteriaQuery<T> having(Predicate... restrictions)
      Description copied from class: AbstractQueryImpl
      Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.
      Specified by:
      having in interface AbstractQuery<T>
      Specified by:
      having in interface CriteriaQuery<T>
      Overrides:
      having in class AbstractQueryImpl<T>
      Parameters:
      restrictions - zero or more restriction predicates
      Returns:
      the modified query

    • having

      public CriteriaQuery<T> having(List<Predicate> restrictions)
      Specified by:
      having in interface AbstractQuery<T>
      Specified by:
      having in interface CriteriaQuery<T>
      Overrides:
      having in class AbstractQueryImpl<T>

    • orderBy

      public CriteriaQuery<T> orderBy(Order... o)
      Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The left-to-right sequence of the ordering expressions determines the precedence, whereby the leftmost has highest precedence.
      Specified by:
      orderBy in interface CriteriaQuery<T>
      Parameters:
      o - zero or more ordering expressions
      Returns:
      the modified query.

    • orderBy

      public CriteriaQuery<T> orderBy(List<Order> o)
      Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The order of the ordering expressions in the list determines the precedence, whereby the first element in the list has highest precedence.
      Specified by:
      orderBy in interface CriteriaQuery<T>
      Parameters:
      o - list of zero or more ordering expressions
      Returns:
      the modified query.

    • populateAndSetConstructorSelection

      public void populateAndSetConstructorSelection(ConstructorSelectionImpl<T> constructorSelection, Class<T> class1, Selection<?>... selections) throws IllegalArgumentException
      This method will set this queryImpl's selection to a ConstructorSelectionImpl, creating a new instance or populating the one passed in as necessary. Throws IllegalArgumentException if a constructor taking arguments represented by the selections array doesn't exist for the given class.

      Also sets the query result to ResultType.CONSTRUCTOR

      Throws:
      IllegalArgumentException

    • distinct

      public CriteriaQuery<T> distinct(boolean distinct)
      Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      distinct in interface AbstractQuery<T>
      Specified by:
      distinct in interface CriteriaQuery<T>
      Overrides:
      distinct in class AbstractQueryImpl<T>
      Parameters:
      distinct - boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained
      Returns:
      the modified query.

    • addJoin

      public void addJoin(FromImpl from)
      Specified by:
      addJoin in class AbstractQueryImpl<T>

    • getDatabaseQuery

      protected ReadAllQuery getDatabaseQuery(boolean toReportQuery)
      Create ReadAllQuery or ReportQuery from content of this instance. May be forced to always return ReportQuery, even when ReadAllQuery is sufficient. This is required for complex queries with UNION/EXCEPT/INTERSECT, where only ReportQuery instance is accepted as part of the query.
      Parameters:
      toReportQuery - force ReportQuery creation.
      Returns:
      ReadAllQuery or ReportQuery from content of this instance

    • getDatabaseQuery

      protected DatabaseQuery getDatabaseQuery()
      Create ReadAllQuery or ReportQuery from content of this instance. Returned class depends on current query complexity.
      Specified by:
      getDatabaseQuery in class CommonAbstractCriteriaImpl<T>
      Returns:
      ReadAllQuery or ReportQuery from content of this instance

    • getOrderList

      public List<Order> getOrderList()
      Return the ordering expressions in order of precedence.
      Specified by:
      getOrderList in interface CriteriaQuery<T>
      Returns:
      the list of ordering expressions

    • getSelection

      public Selection<T> getSelection()
      Return the selection item of the query. This will correspond to the query type.
      Specified by:
      getSelection in interface AbstractQuery<T>
      Returns:
      the selection item of the query

    • createCompoundQuery

      protected ReadAllQuery createCompoundQuery(boolean toReportQuery)
      Translates from the criteria query to a EclipseLink Database Query.

    • createSimpleQuery

      protected ReadAllQuery createSimpleQuery(boolean toReportQuery)

    • translate

      public DatabaseQuery translate()
      Translates from the criteria query to a EclipseLink Database Query.
      Specified by:
      translate in interface CriteriaSelectInternal<T>
      Overrides:
      translate in class CommonAbstractCriteriaImpl<T>
      Returns:
      EclipseLink DatabaseQuery

    • transalteToReportQuery

      public ReportQuery transalteToReportQuery()
      Translate always to ReportQuery.