Jakarta Persistence (JPA) Interface

jakarta.persistence.criteria.CriteriaQuery<T>

Type Parameters:
<T> - the type of the defined result
Super Interfaces:
AbstractQuery<T>, CriteriaSelect<T>, CommonAbstractCriteria
The CriteriaQuery interface defines functionality that is specific to top-level queries.
Since:
Jakarta Persistence (JPA) 2.0
The JPA Criteria API Queries article explains how to use CriteriaQuery.

Public Instance Methods

CriteriaQuery<T> distinct(boolean distinct)
Specify whether duplicate query results are 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.
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..
Since:
Jakarta Persistence (JPA) 1.0
Root<X> from(Class<X> entityClass)
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
Inherited from AbstractQuery<T>
Parameters:
entityClass - the entity class
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
Root<X> from(EntityType<X> entity)
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
Inherited from AbstractQuery<T>
Parameters:
entity - metamodel entity representing the entity of type X
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
List<Expression<?>> getGroupList()
Return a list of the grouping expressions.
Returns empty list if no grouping expressions have been specified. Modifications to the list do not affect the query.
Inherited from AbstractQuery<T>
Returns:
the list of grouping expressions.
Since:
Jakarta Persistence (JPA) 1.0
Predicate getGroupRestriction()
Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.
Inherited from AbstractQuery<T>
Returns:
having clause predicate.
Since:
Jakarta Persistence (JPA) 1.0
List<Order> getOrderList()
Return the ordering expressions in order of precedence.
Returns empty list if no ordering expressions have been specified. Modifications to the list do not affect the query.
Returns:
the list of ordering expressions.
Since:
Jakarta Persistence (JPA) 1.0
Set<ParameterExpression<?>> getParameters()
Return the parameters of the query.
Returns empty set if there are no parameters. Modifications to the set do not affect the query.
Inherited from CommonAbstractCriteria
Returns:
the query parameters.
Since:
Jakarta Persistence (JPA) 1.0
Predicate getRestriction()
Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.
Inherited from CommonAbstractCriteria
Returns:
where clause predicate.
Since:
Jakarta Persistence (JPA) 1.0
Class<T> getResultType()
Return the result type of the query or subquery.
If a result type was specified as an argument to the createQuery or subquery method, that type is returned. If the query was created using the createTupleQuery method, the result type is Tuple. Otherwise, the result type is Object.
Inherited from AbstractQuery<T>
Returns:
result type.
Since:
Jakarta Persistence (JPA) 1.0
Set<Root<?>> getRoots()
Return the query roots.
These are the roots that are defined for the CriteriaQuery<T> or Subquery<T> itself, including any subquery roots defined as a result of correlation. Returns an empty set if no roots have been defined. Modifications to the set do not affect the query.
Inherited from AbstractQuery<T>
Returns:
the set of query roots.
Since:
Jakarta Persistence (JPA) 1.0
Selection<T> getSelection()
Return the selection of the query, or null if no selection has been set.
Inherited from AbstractQuery<T>
Returns:
selection item.
Since:
Jakarta Persistence (JPA) 1.0
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.
Parameters:
grouping - zero or more grouping expressions
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
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.
Parameters:
grouping - list of zero or more grouping expressions
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> having(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.
Parameters:
restriction - a simple or compound boolean expression
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> having(Predicate... restrictions)
Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
Replaces the previously added having 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.
Parameters:
restrictions - zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> having(List<Predicate> restrictions)
Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
Replaces the previously added having 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.
Parameters:
restrictions - a list of zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 3.2
boolean isDistinct()
Return whether duplicate query results must be eliminated or retained.
Inherited from AbstractQuery<T>
Returns:
boolean indicating whether duplicate query results must be eliminated.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> multiselect(Selection<?>... selections)
Specify the selection 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 type of the criteria query object created as well as the arguments to the multiselect method.

An argument to the multiselect method must not be a tuple- or array-valued compound selection item.

The semantics of this method are as follows:

  • If the type of the criteria query is CriteriaQuery (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the arguments of the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution.
  • If the type of the criteria query is CriteriaQuery for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), 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.
  • If the type of the criteria query is CriteriaQuery 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, in the specified order.
  • If the type of the criteria query is CriteriaQuery or if the criteria query was created without specifying a type, 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 or if the criteria query was created without specifying a type, 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, in the specified order.
Parameters:
selections - selection items corresponding to the results to be returned by the query
Returns:
the modified query.
Throws:
IllegalArgumentException - if a selection item is not valid or if more than one selection item has the same assigned alias.
Deprecated:
Since this method is not typesafe, the use of CriteriaBuilder.array or CriteriaBuilder.tuple with select is strongly preferred.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> multiselect(List<Selection<?>> selectionList)
Specify the selection 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 type of the criteria query object created as well as the argument to the multiselect method. An element of the list passed to the multiselect method must not be a tuple- or array-valued compound selection item.

The semantics of this method are as follows:

  • If the type of the criteria query is CriteriaQuery (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the elements of the list passed to the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution.
  • If the type of the criteria query is CriteriaQuery for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), the elements of the 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.
  • If the type of the criteria query is CriteriaQuery for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order.
  • If the type of the criteria query is CriteriaQuery or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains only a single element, an instance of type Object will be returned for each row.
  • If the type of the criteria query is CriteriaQuery or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains more than one element, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order.
Parameters:
selectionList - list of selection items corresponding to the results to be returned by the query
Returns:
the modified query.
Throws:
IllegalArgumentException - if a selection item is not valid or if more than one selection item has the same assigned alias.
Deprecated:
Since this method is not typesafe, the use of CriteriaBuilder.array or CriteriaBuilder.tuple with select is strongly preferred.
Since:
Jakarta Persistence (JPA) 1.0
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 the highest precedence.
Parameters:
o - zero or more ordering expressions
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
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 the highest precedence.
Parameters:
o - list of zero or more ordering expressions
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> select(Selection<? extends T> selection)
Specify the item that is to be returned in the query result.
Replaces the previously specified selection(s), if any.

Note: Applications using the string-based API may need to specify the type of the select item when it results from a get or join operation and the query result type is specified.

For example: 

 CriteriaQuery q = cb.createQuery(String.class);
 Root order = q.from(Order.class);
 q.select(order.get("shippingAddress").get("state"));
 
 CriteriaQuery q2 = cb.createQuery(Product.class);
 q2.select(q2.from(Order.class)
             .join("items")
             .join("product"));
Parameters:
selection - selection specifying the item that is to be returned in the query result
Returns:
the modified query.
Throws:
IllegalArgumentException - if the selection is a compound selection and more than one selection item has the same assigned alias.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(Class<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(EntityType<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> where(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.
Parameters:
restriction - a simple or compound boolean expression
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> where(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.
Parameters:
restrictions - zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaQuery<T> where(List<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.
Parameters:
restrictions - a list of zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 3.2