javax.persistence.criteria
Interface CriteriaQuery<T>

All Superinterfaces:

AbstractQuery<T>

public interface CriteriaQuery<T>
extends AbstractQuery<T>

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<T>	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<ParameterExpression<?>>	getParameters() Return the parameters of the query
Selection<T>	getSelection() Return the selection item of the query.
java.util.List<Selection<?>>	getSelectionList() Return the multiselection items of the query as a list
CriteriaQuery<T>	groupBy(Expression<?>... grouping) Specify the expressions that are used to form groups over the query results.
CriteriaQuery<T>	having(Expression<java.lang.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(Selection<?>... selections) Specify the items that are to be returned in the query result, Replaces the previously specified selections, if any.
CriteriaQuery<T>	orderBy(Order... o) Specify the ordering expressions that are used to order the query results.
CriteriaQuery<T>	select(Selection<T> selection) Specify the item that is to be returned in the query result.
CriteriaQuery<T>	where(Expression<java.lang.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, getRoots, isDistinct, subquery

Method Detail

select

CriteriaQuery<T> select(Selection<T> selection)

Specify the item that is to be returned in the query result. Replaces the previously specified selection, if any.

Parameters:

selection - selection specifying the item that is to be returned in the query result

Returns:

the modified query

multiselect

CriteriaQuery<T> multiselect(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<T> 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<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

where

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.

Specified by:

where in interface AbstractQuery<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

groupBy

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.

Specified by:

groupBy in interface AbstractQuery<T>

Parameters:

grouping - zero or more grouping expressions

Returns:

the modified query

having

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

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

having

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 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<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

orderBy

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

Parameters:

o - zero or more ordering expressions

Returns:

the modified query.

distinct

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

getSelection

Selection<T> getSelection()

Return the selection item of the query. This will correspond to the query type.

Specified by:

getSelection in interface AbstractQuery<T>

Returns:

the selection item of the query

getSelectionList

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

Return the multiselection items of the query as a list

Returns:

the selection items of the query as a list

getOrderList

java.util.List<Order> getOrderList()

Return the ordering expressions in order of precedence.

Returns:

the list of ordering expressions

getParameters

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

Return the parameters of the query

Returns:

the query parameters