javax.persistence.criteria
Interface CriteriaQuery<T>

Type Parameters:

T - type of the defined result

All Superinterfaces:

AbstractQuery<T>

public interface CriteriaQuery<T>
extends AbstractQuery<T>

The CriteriaQuery interface defines functionality that is specific to top-level queries.

Since:

JPA 2.0 version.

Author:

Florent Benoit

See Also:

JPA 2.0 specification

Method Summary

CriteriaQuery<T>	distinct(boolean distinct) Specify whether duplicate query results will be eliminated.
List<Order>	getOrderList() Return the ordering expressions in order of precedence.
Set<ParameterExpression<?>>	getParameters() Return the parameters of the query.
CriteriaQuery<T>	groupBy(Expression<?>... grouping) Specify the expressions that are used to form groups over the query results.
CriteriaQuery<T>	groupBy(List<Expression<?>> grouping) Specify the expressions that are used to form groups over the query results.
CriteriaQuery<T>	having(Expression<Boolean> restriction) Specify a restriction over the groups of the query.
CriteriaQuery<T>	having(Predicate... restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
CriteriaQuery<T>	multiselect(List<Selection<?>> selectionList) Specify the selection items that are to be returned in the query result.
CriteriaQuery<T>	multiselect(Selection<?>... selections) Specify the selection items that are to be returned in the query result.
CriteriaQuery<T>	orderBy(List<Order> o) Specify the ordering expressions that are used to order the query results.
CriteriaQuery<T>	orderBy(Order... o) Specify the ordering expressions that are used to order the query results.
CriteriaQuery<T>	select(Selection<? extends T> selection) Specify the item that is to be returned in the query result.
CriteriaQuery<T>	where(Expression<Boolean> restriction) Modify the query to restrict the query result according to the specified boolean expression.
CriteriaQuery<T>	where(Predicate... restrictions) Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.

Methods inherited from interface javax.persistence.criteria.AbstractQuery

from, from, getGroupList, getGroupRestriction, getRestriction, getResultType, getRoots, getSelection, isDistinct, subquery

Method Detail

select

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

multiselect

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