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

Class CriteriaQueryImpl<T>

  • All Implemented Interfaces:
    jakarta.persistence.criteria.AbstractQuery<T>, jakarta.persistence.criteria.CommonAbstractCriteria, jakarta.persistence.criteria.CriteriaQuery<T>, Serializable
    public class CriteriaQueryImpl<T>
extends AbstractQueryImpl<T>
implements jakarta.persistence.criteria.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
    Author:
    gyorke
    See Also:
    CriteriaQuery, Serialized Form

    • Field Detail

      • orderBy

        protected List<jakarta.persistence.criteria.Order> orderBy

    • Method Detail

      • select

        public jakarta.persistence.criteria.CriteriaQuery<T> select​(jakarta.persistence.criteria.Selection<? extends T> selection)
        Specify the item that is to be returned in the query result. Replaces the previously specified selection, if any.
        Specified by:
        select in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Parameters:
        selection - selection specifying the item that is to be returned in the query result
        Returns:
        the modified query

      • multiselect

        public jakarta.persistence.criteria.CriteriaQuery<T> multiselect​(jakarta.persistence.criteria.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 jakarta.persistence.criteria.CriteriaQuery<T>
        Parameters:
        selections - expressions specifying the items that are to be returned in the query result
        Returns:
        the modified query

      • multiselect

        public jakarta.persistence.criteria.CriteriaQuery<T> multiselect​(List<jakarta.persistence.criteria.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 jakarta.persistence.criteria.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 jakarta.persistence.criteria.CriteriaQuery<T> where​(jakarta.persistence.criteria.Expression<Boolean> restriction)
        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 jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        where in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        where in class AbstractQueryImpl<T>
        Parameters:
        restriction - a simple or compound boolean expression
        Returns:
        the modified query

      • where

        public jakarta.persistence.criteria.CriteriaQuery<T> where​(jakarta.persistence.criteria.Predicate... restrictions)
        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 jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        where in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        where in class AbstractQueryImpl<T>
        Parameters:
        restrictions - zero or more restriction predicates
        Returns:
        the modified query

      • groupBy

        public jakarta.persistence.criteria.CriteriaQuery<T> groupBy​(jakarta.persistence.criteria.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 jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        groupBy in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        groupBy in class AbstractQueryImpl<T>
        Parameters:
        grouping - zero or more grouping expressions
        Returns:
        the modified query

      • groupBy

        public jakarta.persistence.criteria.CriteriaQuery<T> groupBy​(List<jakarta.persistence.criteria.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 jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        groupBy in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        groupBy in class AbstractQueryImpl<T>
        Parameters:
        grouping - list of zero or more grouping expressions
        Returns:
        the modified query

      • having

        public jakarta.persistence.criteria.CriteriaQuery<T> having​(jakarta.persistence.criteria.Expression<Boolean> restriction)
        Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.
        Specified by:
        having in interface jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        having in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        having in class AbstractQueryImpl<T>
        Parameters:
        restriction - a simple or compound boolean expression
        Returns:
        the modified query

      • having

        public jakarta.persistence.criteria.CriteriaQuery<T> having​(jakarta.persistence.criteria.Predicate... restrictions)
        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. This method only overrides the return type of the corresponding AbstractQuery method.
        Specified by:
        having in interface jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        having in interface jakarta.persistence.criteria.CriteriaQuery<T>
        Overrides:
        having in class AbstractQueryImpl<T>
        Parameters:
        restrictions - zero or more restriction predicates
        Returns:
        the modified query

      • orderBy

        public jakarta.persistence.criteria.CriteriaQuery<T> orderBy​(jakarta.persistence.criteria.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 jakarta.persistence.criteria.CriteriaQuery<T>
        Parameters:
        o - zero or more ordering expressions
        Returns:
        the modified query.

      • orderBy

        public jakarta.persistence.criteria.CriteriaQuery<T> orderBy​(List<jakarta.persistence.criteria.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 jakarta.persistence.criteria.CriteriaQuery<T>
        Parameters:
        o - list of zero or more ordering expressions
        Returns:
        the modified query.

      • populateAndSetConstructorSelection

        public void populateAndSetConstructorSelection​(ConstructorSelectionImpl constructorSelection,
                                               Class<?> class1,
                                               jakarta.persistence.criteria.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
        Parameters:
        class1 -
        selections -
        Throws:
        IllegalArgumentException

      • distinct

        public jakarta.persistence.criteria.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 jakarta.persistence.criteria.AbstractQuery<T>
        Specified by:
        distinct in interface jakarta.persistence.criteria.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.

      • getOrderList

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

      • getSelection

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

      • createCompoundQuery

        protected ObjectLevelReadQuery createCompoundQuery()
        Translates from the criteria query to a EclipseLink Database Query.