Jakarta EE 11.0.0 · jakarta.persistence.criteria.CriteriaQuery

Method Summary

Modifier and Type	Method and Description
public CriteriaQuery<T>	Returns: the modified query. distinct(boolean boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained distinct) Redeclares jakarta.persistence.criteria.AbstractQuery.distinct. Specify whether duplicate query results are eliminated.
public List<Order>	Returns: the list of ordering expressions getOrderList() Return the ordering expressions in order of precedence.
public CriteriaQuery<T>	Returns: the modified query groupBy(Expression<?>... zero or more grouping expressions grouping) Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy. Specify the expressions that are used to form groups over the query results.
public CriteriaQuery<T>	Returns: the modified query groupBy(List<Expression<?>> list of zero or more grouping expressions grouping) Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy. Specify the expressions that are used to form groups over the query results.
public CriteriaQuery<T>	Returns: the modified query having(Expression<Boolean> a simple or compound boolean expression restriction) Redeclares jakarta.persistence.criteria.AbstractQuery.having. Specify a restriction over the groups of the query.
public CriteriaQuery<T>	Returns: the modified query having(Predicate... zero or more restriction predicates restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.having. Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
public CriteriaQuery<T>	Returns: the modified query having(List<Predicate> a list of zero or more restriction predicates restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.having. Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
public CriteriaQuery<T>	Returns: the modified query multiselect(Selection<?>... selection items corresponding to the results to be returned by the query selections) Deprecated since 3.2. Since this method is not typesafe, the use of `CriteriaBuilder#array` or `CriteriaBuilder#tuple` with `select` is strongly preferred. Specify the selection items that are to be returned in the query result.
public CriteriaQuery<T>	Returns: the modified query multiselect(List<Selection<?>> list of selection items corresponding to the results to be returned by the query selectionList) Deprecated since 3.2. Since this method is not typesafe, the use of `CriteriaBuilder#array` or `CriteriaBuilder#tuple` with `select` is strongly preferred. Specify the selection items that are to be returned in the query result.
public CriteriaQuery<T>	Returns: the modified query orderBy(Order... zero or more ordering expressions o) Specify the ordering expressions that are used to order the query results.
public CriteriaQuery<T>	Returns: the modified query orderBy(List<Order> list of zero or more ordering expressions o) Specify the ordering expressions that are used to order the query results.
public CriteriaQuery<T>	Returns: the modified query select(Selection<? extends T> selection specifying the item that is to be returned in the query result selection) Specify the item that is to be returned in the query result.
public CriteriaQuery<T>	Returns: the modified query where(Expression<Boolean> a simple or compound boolean expression restriction) Redeclares jakarta.persistence.criteria.AbstractQuery.where. Modify the query to restrict the query result according to the specified boolean expression.
public CriteriaQuery<T>	Returns: the modified query where(Predicate... zero or more restriction predicates restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.where. Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.
public CriteriaQuery<T>	Returns: the modified query where(List<Predicate> a list of zero or more restriction predicates restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.where. Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.

Inherited from jakarta.persistence.criteria.AbstractQuery:: from from getGroupList getGroupRestriction getResultType getRoots getSelection isDistinct

Method Detail

distinct back to summary

distinct	back to summary
public CriteriaQuery<T> distinct(boolean distinct) Redeclares jakarta.persistence.criteria.AbstractQuery.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 boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained Returns:CriteriaQuery<T> the modified query.

public CriteriaQuery<T> distinct(boolean distinct)

Redeclares jakarta.persistence.criteria.AbstractQuery.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: boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained

Returns:CriteriaQuery<T>

the modified query.

getOrderList	back to summary
public 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:List<Order> the list of ordering expressions

getOrderList

back to summary

public 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:List<Order>: the list of ordering expressions

groupBy back to summary

groupBy	back to summary
public CriteriaQuery<T> groupBy(Expression<?>... grouping) Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy. 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:Expression<?>[] zero or more grouping expressions Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> groupBy(Expression<?>... grouping)

Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy.

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:Expression<?>[]: zero or more grouping expressions

Returns:CriteriaQuery<T>

the modified query

groupBy back to summary

groupBy	back to summary
public CriteriaQuery<T> groupBy(List<Expression<?>> grouping) Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy. 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<Expression<?>> list of zero or more grouping expressions Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> groupBy(List<Expression<?>> grouping)

Redeclares jakarta.persistence.criteria.AbstractQuery.groupBy.

Parameters

grouping:List<Expression<?>>: list of zero or more grouping expressions

Returns:CriteriaQuery<T>

the modified query

having back to summary

having	back to summary
public CriteriaQuery<T> having(Expression<Boolean> restriction) Redeclares jakarta.persistence.criteria.AbstractQuery.having. 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:Expression<Boolean> a simple or compound boolean expression Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> having(Expression<Boolean> restriction)

Redeclares jakarta.persistence.criteria.AbstractQuery.having.

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:Expression<Boolean>: a simple or compound boolean expression

Returns:CriteriaQuery<T>

the modified query

having back to summary

having	back to summary
public CriteriaQuery<T> having(Predicate... restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.having. 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:Predicate[] zero or more restriction predicates Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> having(Predicate... restrictions)

Redeclares jakarta.persistence.criteria.AbstractQuery.having.

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:Predicate[]: zero or more restriction predicates

Returns:CriteriaQuery<T>

the modified query

having back to summary

having	back to summary
public CriteriaQuery<T> having(List<Predicate> restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.having. 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:List<Predicate> a list of zero or more restriction predicates Returns:CriteriaQuery<T> the modified query Since 3.2

public CriteriaQuery<T> having(List<Predicate> restrictions)

Redeclares jakarta.persistence.criteria.AbstractQuery.having.

Parameters

restrictions:List<Predicate>: a list of zero or more restriction predicates

Returns:CriteriaQuery<T>

the modified query

Since

3.2

multiselect back to summary

multiselect	back to summary
public CriteriaQuery<T> multiselect(Selection<?>... selections) Deprecated since 3.2. Since this method is not typesafe, the use of `CriteriaBuilder#array` or `CriteriaBuilder#tuple` with `select` is strongly preferred. 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<Tuple>` (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<X>` 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<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, in the specified order. If the type of the criteria query is `CriteriaQuery<Object>` 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<Object>` 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<?>[] selection items corresponding to the results to be returned by the query Returns:CriteriaQuery<T> the modified query Annotations @Deprecated since:3.2 Exceptions IllegalArgumentException: if a selection item is not valid or if more than one selection item has the same assigned alias

public CriteriaQuery<T> multiselect(Selection<?>... selections)

Deprecated

since 3.2.

Since this method is not typesafe, the use of CriteriaBuilder#array or CriteriaBuilder#tuple with select is strongly preferred.

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<Tuple> (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<X> 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<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, in the specified order.
If the type of the criteria query is CriteriaQuery<Object> 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<Object> 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<?>[]: selection items corresponding to the results to be returned by the query

Returns:CriteriaQuery<T>

the modified query

Annotations

@Deprecated
since:3.2

Exceptions

IllegalArgumentException:: if a selection item is not valid or if more than one selection item has the same assigned alias

multiselect back to summary

multiselect	back to summary
public CriteriaQuery<T> multiselect(List<Selection<?>> selectionList) Deprecated since 3.2. Since this method is not typesafe, the use of `CriteriaBuilder#array` or `CriteriaBuilder#tuple` with `select` is strongly preferred. 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<Tuple>` (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<X>` 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<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 elements of the list passed to the `multiselect` method, in the specified order. If the type of the criteria query is `CriteriaQuery<Object>` 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<Object>` 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<Selection<?>> list of selection items corresponding to the results to be returned by the query Returns:CriteriaQuery<T> the modified query Annotations @Deprecated since:3.2 Exceptions IllegalArgumentException: if a selection item is not valid or if more than one selection item has the same assigned alias

public CriteriaQuery<T> multiselect(List<Selection<?>> selectionList)

Deprecated

since 3.2.

Since this method is not typesafe, the use of CriteriaBuilder#array or CriteriaBuilder#tuple with select is strongly preferred.

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<Tuple> (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<X> 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<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 elements of the list passed to the multiselect method, in the specified order.
If the type of the criteria query is CriteriaQuery<Object> 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<Object> 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<Selection<?>>: list of selection items corresponding to the results to be returned by the query

Returns:CriteriaQuery<T>

the modified query

Annotations

@Deprecated
since:3.2

Exceptions

IllegalArgumentException:: if a selection item is not valid or if more than one selection item has the same assigned alias

orderBy	back to summary
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 the highest precedence. Parameters o:Order[] zero or more ordering expressions Returns:CriteriaQuery<T> the modified query

orderBy

back to summary

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 the highest precedence.

Parameters

o:Order[]: zero or more ordering expressions

Returns:CriteriaQuery<T>

the modified query

orderBy	back to summary
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 the highest precedence. Parameters o:List<Order> list of zero or more ordering expressions Returns:CriteriaQuery<T> the modified query

orderBy

back to summary

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 the highest precedence.

Parameters

o:List<Order>: list of zero or more ordering expressions

Returns:CriteriaQuery<T>

the modified query

select back to summary

select	back to summary
public 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<String> q = cb.createQuery(String.class); Root<Order> order = q.from(Order.class); q.select(order.get("shippingAddress").<String>get("state")); CriteriaQuery<Product> q2 = cb.createQuery(Product.class); q2.select(q2.from(Order.class) .join("items") .<Item, Product>join("product"));` CriteriaQuery<String> q = cb.createQuery(String.class); Root<Order> order = q.from(Order.class); q.select(order.get("shippingAddress").<String>get("state")); CriteriaQuery<Product> q2 = cb.createQuery(Product.class); q2.select(q2.from(Order.class) .join("items") .<Item, Product>join("product")); Parameters selection:Selection<? extends T> selection specifying the item that is to be returned in the query result Returns:CriteriaQuery<T> the modified query Exceptions IllegalArgumentException: if the selection is a compound selection and more than one selection item has the same assigned alias

public 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<String> q = cb.createQuery(String.class);
Root<Order> order = q.from(Order.class);
q.select(order.get("shippingAddress").<String>get("state"));

CriteriaQuery<Product> q2 = cb.createQuery(Product.class);
q2.select(q2.from(Order.class)
            .join("items")
            .<Item, Product>join("product"));

Parameters

selection:Selection<? extends T>: selection specifying the item that is to be returned in the query result

Returns:CriteriaQuery<T>

the modified query

Exceptions

IllegalArgumentException:: if the selection is a compound selection and more than one selection item has the same assigned alias

where back to summary

where	back to summary
public CriteriaQuery<T> where(Expression<Boolean> restriction) Redeclares jakarta.persistence.criteria.AbstractQuery.where. 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:Expression<Boolean> a simple or compound boolean expression Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> where(Expression<Boolean> restriction)

Redeclares jakarta.persistence.criteria.AbstractQuery.where.

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:Expression<Boolean>: a simple or compound boolean expression

Returns:CriteriaQuery<T>

the modified query

where back to summary

where	back to summary
public CriteriaQuery<T> where(Predicate... restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.where. 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:Predicate[] zero or more restriction predicates Returns:CriteriaQuery<T> the modified query

public CriteriaQuery<T> where(Predicate... restrictions)

Redeclares jakarta.persistence.criteria.AbstractQuery.where.

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:Predicate[]: zero or more restriction predicates

Returns:CriteriaQuery<T>

the modified query

where back to summary

where	back to summary
public CriteriaQuery<T> where(List<Predicate> restrictions) Redeclares jakarta.persistence.criteria.AbstractQuery.where. 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:List<Predicate> a list of zero or more restriction predicates Returns:CriteriaQuery<T> the modified query Since 3.2

public CriteriaQuery<T> where(List<Predicate> restrictions)

Redeclares jakarta.persistence.criteria.AbstractQuery.where.

Parameters

restrictions:List<Predicate>: a list of zero or more restriction predicates

Returns:CriteriaQuery<T>

the modified query

Since

3.2

public Interface CriteriaQuery<T>

Method Summary

Method Detail