javax.persistence.criteria.CriteriaQuery - JPA interface
javax.persistence.criteria
Interface CriteriaQuery<T>
- Superinterfaces:
AbstractQuery<T>
CriteriaQuery
interface defines functionality that is specific to top-level queries.- Since:
- JPA 2.0
- 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:
- JPA 2.0
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:
- JPA 2.0
- Parameters:
entityClass
- the entity class
- Returns:
- query root corresponding to the given entity
- Since:
- JPA 2.0
- Parameters:
entity
- metamodel entity representing the entity of type X
- Returns:
- query root corresponding to the given entity
- Since:
- JPA 2.0
- Returns:
- the list of grouping expressions
- Since:
- JPA 2.0
- Returns:
- having clause predicate
- Since:
- JPA 2.0
- Returns:
- the list of ordering expressions
- Since:
- JPA 2.0
- Returns:
- the query parameters
- Since:
- JPA 2.0
- Returns:
- where clause predicate
- Since:
- JPA 2.0
createQuery
or subquery
method, that type will be returned. If the query was created using the createTupleQuery
method, the result type is Tuple
. Otherwise, the result type is Object
.- Returns:
- result type
- Since:
- JPA 2.0
CriteriaQuery
or Subquery
itself, including any subquery roots defined as a result of correlation. Returns empty set if no roots have been defined. Modifications to the set do not affect the query.- Returns:
- the set of query roots
- Since:
- JPA 2.0
- Returns:
- selection item
- Since:
- JPA 2.0
- Parameters:
grouping
- list of zero or more grouping expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
grouping
- list of zero or more grouping expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
- Parameters:
grouping
- zero or more grouping expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
grouping
- zero or more grouping expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
- Parameters:
restrictions
- zero or more restriction predicates
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
restrictions
- zero or more restriction predicates
- Returns:
- the modified query
- Since:
- JPA 2.0
- Parameters:
restriction
- a simple or compound boolean expression
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
restriction
- a simple or compound boolean expression
- Returns:
- the modified query
- Since:
- JPA 2.0
- Returns:
- boolean indicating whether duplicate query results must be eliminated
- Since:
- JPA 2.0
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 thecreateTupleQuery
method or by passing aTuple
class argument to thecreateQuery
method), aTuple
object corresponding to the elements of the list passed to themultiselect
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 thecreateQuery
method), the elements of the list passed to themultiselect
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 themultiselect
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 themultiselect
method contains only a single element, an instance of typeObject
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 themultiselect
method contains more than one element, an instance of typeObject[]
will be instantiated and returned for each row. The elements of the array will correspond to the elements of the list passed to themultiselect
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
- Since:
- JPA 2.0
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 thecreateTupleQuery
method or by passing aTuple
class argument to thecreateQuery
method), aTuple
object corresponding to the arguments of themultiselect
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 thecreateQuery
method), the arguments to themultiselect
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 themultiselect
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 themultiselect
method, an instance of typeObject
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 themultiselect
method, an instance of typeObject[]
will be instantiated and returned for each row. The elements of the array will correspond to the arguments to themultiselect
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
- Since:
- JPA 2.0
- Parameters:
o
- list of zero or more ordering expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
- Parameters:
o
- zero or more ordering expressions
- Returns:
- the modified query
- Since:
- JPA 2.0
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:
- JPA 2.0
- Parameters:
type
- the subquery result type
- Returns:
- subquery
- Since:
- JPA 2.0
- Parameters:
restrictions
- zero or more restriction predicates
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
restrictions
- zero or more restriction predicates
- Returns:
- the modified query
- Since:
- JPA 2.0
- Parameters:
restriction
- a simple or compound boolean expression
- Returns:
- the modified query
- Since:
- JPA 2.0
AbstractQuery
method.- Parameters:
restriction
- a simple or compound boolean expression
- Returns:
- the modified query
- Since:
- JPA 2.0