javax.persistence.criteria
Interface CriteriaQuery

All Superinterfaces:

AbstractQuery

public interface CriteriaQuery
extends AbstractQuery

The interface CriteriaQuery defines functionality that is specific to top-level queries. A top-level query has an ordered list of selections.

Method Summary

CriteriaQuery	distinct(boolean distinct) Specify whether duplicate query results will be eliminated.
java.util.List<Order>	getOrderList() Return the ordering expressions in order of precedence.
java.util.Set<Parameter<?>>	getParameters() Return the parameters of the query
java.util.List<Selection<?>>	getSelectionList() Return the selection list of the query
CriteriaQuery	groupBy(Expression<?>... grouping) Specify the expressions that are used to form groups over the query results.
CriteriaQuery	having(Expression<java.lang.Boolean> restriction) Specify a restriction over the groups of the query.
CriteriaQuery	having(Predicate... restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
CriteriaQuery	orderBy(Order... o) Specify the ordering expressions that are used to order the query results.
CriteriaQuery	select(Selection<?>... selections) Specify the items that are to be returned in the query result.
CriteriaQuery	where(Expression<java.lang.Boolean> restriction) Modify the query to restrict the query result according to the specified boolean expression.
CriteriaQuery	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, getRoots, isDistinct, subquery

Method Detail

select

CriteriaQuery select(Selection<?>... selections)

Specify the items that are to be returned in the query result. Replaces the previously specified selections, if any.

Parameters:

selections - expressions specifying the items that are returned in the query result

Returns:

the modified query

where

CriteriaQuery where(Expression<java.lang.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 AbstractQuery

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

where

CriteriaQuery 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.

Specified by:

where in interface AbstractQuery

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

groupBy

CriteriaQuery 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

Parameters:

grouping - zero or more grouping expressions

Returns:

the modified query

having

CriteriaQuery having(Expression<java.lang.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 AbstractQuery

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

having

CriteriaQuery having(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 AbstractQuery

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

orderBy

CriteriaQuery 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.

Parameters:

o - zero or more ordering expressions

Returns:

the modified query.

distinct

CriteriaQuery 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

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.

getSelectionList

java.util.List<Selection<?>> getSelectionList()

Return the selection list of the query

Returns:

the list of items to be returned in the query result

getOrderList

java.util.List<Order> getOrderList()

Return the ordering expressions in order of precedence.

Returns:

the list of ordering expressions

getParameters

java.util.Set<Parameter<?>> getParameters()

Return the parameters of the query

Returns:

the query parameters