Jakarta EE 11.0.0 · jakarta.persistence.criteria.AbstractQuery

Method Summary

Modifier and Type	Method and Description
public AbstractQuery<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) Specify whether duplicate query results are eliminated.
public <X> Root<X>	Returns: query root corresponding to the given entity from(Class<X> the entity class entityClass) Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
public <X> Root<X>	Returns: query root corresponding to the given entity from(EntityType<X> metamodel entity representing the entity of type X entity) Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
public List<Expression<?>>	Returns: the list of grouping expressions getGroupList() Return a list of the grouping expressions.
public Predicate	Returns: having clause predicate getGroupRestriction() Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.
public Class<T>	Returns: result type getResultType() Return the result type of the query or subquery.
public Set<Root<?>>	Returns: the set of query roots getRoots() Return the query roots.
public Selection<T>	Returns: selection item getSelection() Return the selection of the query, or null if no selection has been set.
public AbstractQuery<T>	Returns: the modified query groupBy(Expression<?>... zero or more grouping expressions grouping) Specify the expressions that are used to form groups over the query results.
public AbstractQuery<T>	Returns: the modified query groupBy(List<Expression<?>> list of zero or more grouping expressions grouping) Specify the expressions that are used to form groups over the query results.
public AbstractQuery<T>	Returns: the modified query having(Expression<Boolean> a simple or compound boolean expression restriction) Specify a restriction over the groups of the query.
public AbstractQuery<T>	Returns: the modified query having(Predicate... zero or more restriction predicates restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
public AbstractQuery<T>	Returns: the modified query having(List<Predicate> a list of zero or more restriction predicates restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
public boolean	Returns: boolean indicating whether duplicate query results must be eliminated isDistinct() Return whether duplicate query results must be eliminated or retained.
public AbstractQuery<T>	Returns: the modified query where(Expression<Boolean> a simple or compound boolean expression restriction) Modify the query to restrict the query results according to the specified boolean expression.
public AbstractQuery<T>	Returns: the modified query where(Predicate... zero or more restriction predicates restrictions) Modify the query to restrict the query results according to the conjunction of the specified restriction predicates.
public AbstractQuery<T>	Returns: the modified query where(List<Predicate> a list of zero or more restriction predicates restrictions) Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.

Inherited from jakarta.persistence.criteria.CommonAbstractCriteria:: getParameters getRestriction subquery subquery

Method Detail

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

distinct

back to summary

public AbstractQuery<T> distinct(boolean 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.

Parameters

distinct:boolean: boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained

Returns:AbstractQuery<T>

the modified query

from	back to summary
public <X> Root<X> from(Class<X> entityClass) Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots. Parameters entityClass:Class<X> the entity class Returns:Root<X> query root corresponding to the given entity

from

back to summary

public <X> Root<X> from(Class<X> entityClass)

Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.

Parameters

entityClass:Class<X>: the entity class

Returns:Root<X>

query root corresponding to the given entity

from	back to summary
public <X> Root<X> from(EntityType<X> entity) Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots. Parameters entity:EntityType<X> metamodel entity representing the entity of type X Returns:Root<X> query root corresponding to the given entity

from

back to summary

public <X> Root<X> from(EntityType<X> entity)

Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.

Parameters

entity:EntityType<X>: metamodel entity representing the entity of type X

Returns:Root<X>

query root corresponding to the given entity

getGroupList	back to summary
public List<Expression<?>> getGroupList() Return a list of the grouping expressions. Returns empty list if no grouping expressions have been specified. Modifications to the list do not affect the query. Returns:List<Expression<?>> the list of grouping expressions

getGroupList

back to summary

public List<Expression<?>> getGroupList()

Return a list of the grouping expressions. Returns empty list if no grouping expressions have been specified. Modifications to the list do not affect the query.

Returns:List<Expression<?>>: the list of grouping expressions

getGroupRestriction	back to summary
public Predicate getGroupRestriction() Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified. Returns:Predicate having clause predicate

getGroupRestriction

back to summary

public Predicate getGroupRestriction()

Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.

Returns:Predicate: having clause predicate

getResultType back to summary

getResultType	back to summary
public Class<T> getResultType() Return the result type of the query or subquery. If a result type was specified as an argument to the `createQuery` or `subquery` method, that type is returned. If the query was created using the `createTupleQuery` method, the result type is `Tuple`. Otherwise, the result type is `Object`. Returns:Class<T> result type

public Class<T> getResultType()

Return the result type of the query or subquery. If a result type was specified as an argument to the createQuery or subquery method, that type is returned. If the query was created using the createTupleQuery method, the result type is Tuple. Otherwise, the result type is Object.

Returns:Class<T>: result type

getRoots back to summary

getRoots	back to summary
public Set<Root<?>> getRoots() Return the query roots. These are the roots that are defined for the `CriteriaQuery` or `Subquery` itself, including any subquery roots defined as a result of correlation. Returns an empty set if no roots have been defined. Modifications to the set do not affect the query. Returns:Set<Root<?>> the set of query roots

public Set<Root<?>> getRoots()

Return the query roots. These are the roots that are defined for the CriteriaQuery or Subquery itself, including any subquery roots defined as a result of correlation. Returns an empty set if no roots have been defined. Modifications to the set do not affect the query.

Returns:Set<Root<?>>: the set of query roots

getSelection	back to summary
public Selection<T> getSelection() Return the selection of the query, or null if no selection has been set. Returns:Selection<T> selection item

getSelection

back to summary

public Selection<T> getSelection()

Return the selection of the query, or null if no selection has been set.

Returns:Selection<T>: selection item

groupBy	back to summary
public AbstractQuery<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. Parameters grouping:Expression<?>[] zero or more grouping expressions Returns:AbstractQuery<T> the modified query

groupBy

back to summary

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

Parameters

grouping:Expression<?>[]: zero or more grouping expressions

Returns:AbstractQuery<T>

the modified query

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

groupBy

back to summary

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

Parameters

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

Returns:AbstractQuery<T>

the modified query

having	back to summary
public AbstractQuery<T> having(Expression<Boolean> restriction) Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. Parameters restriction:Expression<Boolean> a simple or compound boolean expression Returns:AbstractQuery<T> the modified query

having

back to summary

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

Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any.

Parameters

restriction:Expression<Boolean>: a simple or compound boolean expression

Returns:AbstractQuery<T>

the modified query

having	back to summary
public AbstractQuery<T> having(Predicate... restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously having added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. Parameters restrictions:Predicate[] zero or more restriction predicates Returns:AbstractQuery<T> the modified query

having

back to summary

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

Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously having added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.

Parameters

restrictions:Predicate[]: zero or more restriction predicates

Returns:AbstractQuery<T>

the modified query

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

having

back to summary

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

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.

Parameters

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

Returns:AbstractQuery<T>

the modified query

Since

3.2

isDistinct	back to summary
public boolean isDistinct() Return whether duplicate query results must be eliminated or retained. Returns:boolean boolean indicating whether duplicate query results must be eliminated

isDistinct

back to summary

public boolean isDistinct()

Return whether duplicate query results must be eliminated or retained.

Returns:boolean: boolean indicating whether duplicate query results must be eliminated

where	back to summary
public AbstractQuery<T> where(Expression<Boolean> restriction) Modify the query to restrict the query results according to the specified boolean expression. Replaces the previously added restriction(s), if any. Parameters restriction:Expression<Boolean> a simple or compound boolean expression Returns:AbstractQuery<T> the modified query

where

back to summary

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

Modify the query to restrict the query results according to the specified boolean expression. Replaces the previously added restriction(s), if any.

Parameters

restriction:Expression<Boolean>: a simple or compound boolean expression

Returns:AbstractQuery<T>

the modified query

where	back to summary
public AbstractQuery<T> where(Predicate... restrictions) Modify the query to restrict the query results 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. Parameters restrictions:Predicate[] zero or more restriction predicates Returns:AbstractQuery<T> the modified query

where

back to summary

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

Modify the query to restrict the query results 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.

Parameters

restrictions:Predicate[]: zero or more restriction predicates

Returns:AbstractQuery<T>

the modified query

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

where

back to summary

public AbstractQuery<T> where(List<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.

Parameters

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

Returns:AbstractQuery<T>

the modified query

Since

3.2

public Interface AbstractQuery<T>

Method Summary

Method Detail