Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.querydef

Class AbstractQueryImpl<T>

java.lang.Object

org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl<T>

org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl<T>

All Implemented Interfaces:

AbstractQuery<T>, CommonAbstractCriteria, Serializable

Direct Known Subclasses:

CriteriaQueryImpl, SubQueryImpl

public abstract class AbstractQueryImpl<T>
extends CommonAbstractCriteriaImpl<T>
implements AbstractQuery<T>

Purpose: Contains the implementation of the AbstractQuery interface of the JPA criteria API.

Description: This is the container class for the components that define a query. This is the superclass of both the CriteriaQuery and the SubQuery.

Since:

EclipseLink 1.2

See Also:

• CriteriaQuery
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractQueryImpl.ResultType

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	baseExpression
protected boolean	distinct
protected List<Expression<?>>	groupBy
protected Predicate	havingClause
protected AbstractQueryImpl.ResultType	queryResult
protected Set<Root<?>>	roots

Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl

metamodel, parameters, queryBuilder, queryType, where

Constructor Summary

Constructors

Constructor	Description
AbstractQueryImpl(Metamodel metamodel, AbstractQueryImpl.ResultType queryResult, CriteriaBuilderImpl queryBuilder, Class<T> resultType)

Method Summary

Modifier and Type	Method	Description
abstract void	addJoin(FromImpl join)
AbstractQuery<T>	distinct(boolean distinct)	Specify whether duplicate query results will be eliminated.
protected void	findJoins(FromImpl root)
<X> Root<X>	from(EntityType<X> entity)	Add a query root corresponding to the given entity, forming a Cartesian product with any existing roots.
<X> Root<X>	from(Class<X> entityClass)	Add a query root corresponding to the given entity, forming a Cartesian product with any existing roots.
protected Expression	getBaseExpression()
protected Expression	getBaseExpression(Root root)
List<Expression<?>>	getGroupList()	Return a list of the grouping expressions
Predicate	getGroupRestriction()	Return the predicate that corresponds to the restriction(s) over the grouping items.
Set<Root<?>>	getRoots()	Return the query roots.
AbstractQuery<T>	groupBy(Expression<?>... grouping)	Specify the expressions that are used to form groups over the query results.
AbstractQuery<T>	groupBy(List<Expression<?>> grouping)	Specify the expressions that are used to form groups over the query results.
AbstractQuery<T>	having(Expression<Boolean> restriction)	Specify a restriction over the groups of the query.
AbstractQuery<T>	having(Predicate... restrictions)	Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
protected void	integrateRoot(RootImpl root)	Used to use a root from a different query.
boolean	isDistinct()	Return whether duplicate query results must be eliminated or retained.
AbstractQuery<T>	where(Expression<Boolean> restriction)	Modify the query to restrict the query result according to the specified boolean expression.
AbstractQuery<T>	where(Predicate... restrictions)	Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.

Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl

addParameter, findRootAndParameters, findRootAndParameters, getDatabaseQuery, getParameters, getRestriction, getResultType, internalFrom, internalFrom, subquery, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.persistence.criteria.AbstractQuery

getResultType, getSelection

Methods inherited from interface jakarta.persistence.criteria.CommonAbstractCriteria

getRestriction, subquery

Field Details

queryResult

protected AbstractQueryImpl.ResultType queryResult

distinct

protected boolean distinct

havingClause

protected Predicate havingClause

groupBy

protected List<Expression<?>> groupBy

roots

protected Set<Root<?>> roots

baseExpression

protected Expression baseExpression

Constructor Details

AbstractQueryImpl

public AbstractQueryImpl(Metamodel metamodel,
 AbstractQueryImpl.ResultType queryResult,
 CriteriaBuilderImpl queryBuilder,
 Class<T> resultType)

Method Details

groupBy

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.

Specified by:

groupBy in interface AbstractQuery<T>

Parameters:

grouping - list of zero or more grouping expressions

Returns:

the modified query

groupBy

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.

Specified by:

groupBy in interface AbstractQuery<T>

Parameters:

grouping - zero or more grouping expressions

Returns:

the modified query

having

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

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

Specified by:

having in interface AbstractQuery<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

having

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 added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.

Specified by:

having in interface AbstractQuery<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

addJoin

public abstract void addJoin(FromImpl join)

distinct

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

getBaseExpression

protected Expression getBaseExpression()

Specified by:

getBaseExpression in class CommonAbstractCriteriaImpl<T>

getBaseExpression

protected Expression getBaseExpression(Root root)

getGroupList

public List<Expression<?>> getGroupList()

Return a list of the grouping expressions

Specified by:

getGroupList in interface AbstractQuery<T>

Returns:

the list of grouping expressions

getGroupRestriction

public Predicate getGroupRestriction()

Return the predicate that corresponds to the restriction(s) over the grouping items.

Specified by:

getGroupRestriction in interface AbstractQuery<T>

Returns:

having clause predicate

getRoots

public Set<Root<?>> getRoots()

Return the query roots.

Specified by:

getRoots in interface AbstractQuery<T>

Returns:

the set of query roots

integrateRoot

protected void integrateRoot(RootImpl root)

Description copied from class: CommonAbstractCriteriaImpl

Used to use a root from a different query.

Specified by:

integrateRoot in class CommonAbstractCriteriaImpl<T>

isDistinct

public boolean isDistinct()

Return whether duplicate query results must be eliminated or retained.

Specified by:

isDistinct in interface AbstractQuery<T>

Returns:

boolean indicating whether duplicate query results must be eliminated

findJoins

protected void findJoins(FromImpl root)

from

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

Add a query root corresponding to the given entity, forming a Cartesian product with any existing roots.

Specified by:

from in interface AbstractQuery<T>

Parameters:

entity - metamodel entity representing the entity of type X

Returns:

query root corresponding to the given entity

from

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

Add a query root corresponding to the given entity, forming a Cartesian product with any existing roots.

Specified by:

from in interface AbstractQuery<T>

Parameters:

entityClass - the entity class

Returns:

query root corresponding to the given entity

where

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

Overrides:

where in class CommonAbstractCriteriaImpl<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

where

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

Overrides:

where in class CommonAbstractCriteriaImpl<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query