Package org.hibernate.query.sqm.tree.select

Class AbstractSqmSelectQuery<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery<T>

All Implemented Interfaces:

AbstractQuery<T>, CommonAbstractCriteria, Serializable, JpaCriteriaBase, JpaCriteriaNode, JpaCteContainer, JpaSelectCriteria<T>, SqmCteContainer, SqmSelectQuery<T>, SqmNode, SqmQuery<T>

Direct Known Subclasses:

SqmSelectStatement, SqmSubQuery

public abstract class AbstractSqmSelectQuery<T>
extends AbstractSqmNode
implements SqmSelectQuery<T>

Author:

Steve Ebersole

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractSqmSelectQuery(Class<T> resultType, NodeBuilder builder)
protected	AbstractSqmSelectQuery(NodeBuilder builder, Map<String,SqmCteStatement<?>> cteStatements, Class<T> resultType)
	AbstractSqmSelectQuery(SqmQueryPart<T> queryPart, Class<T> resultType, NodeBuilder builder)
	AbstractSqmSelectQuery(SqmQueryPart<T> queryPart, Map<String,SqmCteStatement<?>> cteStatements, Class<T> resultType, NodeBuilder builder)

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder sb)
protected Map<String,SqmCteStatement<?>>	copyCteStatements(SqmCopyContext context)
SqmSelectQuery<T>	distinct(boolean distinct)	Specify whether duplicate query results will be eliminated.
<X> SqmDerivedRoot<X>	from(Subquery<X> subquery)	Create and add a query root corresponding to the given subquery, forming a cartesian product with any existing roots.
<X> SqmRoot<X>	from(EntityType<X> entityType)	Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
<X> SqmRoot<X>	from(Class<X> entityClass)	Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
<X> JpaRoot<X>	from(JpaCteCriteria<X> cte)	Create and add a query root corresponding to the given cte, forming a cartesian product with any existing roots.
<X> JpaCteCriteria<X>	getCteCriteria(String cteName)	Returns a CTE that is registered by the given name on this container, or any of its parents.
Collection<? extends JpaCteCriteria<?>>	getCteCriterias()	Returns the CTEs that are registered on this container.
SqmCteStatement<?>	getCteStatement(String cteLabel)
Collection<SqmCteStatement<?>>	getCteStatements()
List<Expression<?>>	getGroupList()	Return a list of the grouping expressions.
SqmPredicate	getGroupRestriction()	Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.
SqmQueryPart<T>	getQueryPart()	The query structure.
SqmQuerySpec<T>	getQuerySpec()	The query structure.
SqmPredicate	getRestriction()	Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.
protected Selection<? extends T>	getResultSelection(Selection<?>[] selections)
Class<T>	getResultType()	Return the result type of the query or subquery.
List<Root<?>>	getRootList()
Set<Root<?>>	getRoots()	Return the query roots.
JpaSelection<T>	getSelection()	Return the selection of the query, or null if no selection has been set.
SqmSelectQuery<T>	groupBy(Expression<?>... expressions)	Specify the expressions that are used to form groups over the query results.
SqmSelectQuery<T>	groupBy(List<Expression<?>> grouping)	Specify the expressions that are used to form groups over the query results.
SqmSelectQuery<T>	having(Expression<Boolean> booleanExpression)	Specify a restriction over the groups of the query.
SqmSelectQuery<T>	having(Predicate... predicates)	Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
boolean	isDistinct()	Return whether duplicate query results must be eliminated or retained.
void	setQueryPart(SqmQueryPart<T> sqmQueryPart)
protected void	setResultType(Class<T> resultType)	Deprecated, for removal: This API element is subject to removal in a future version. Don't use this method.
SqmSelectQuery<T>	where(Expression<Boolean> restriction)	Modify the query to restrict the query results according to the specified boolean expression.
SqmSelectQuery<T>	where(Predicate... restrictions)	Modify the query to restrict the query results according to the conjunction of the specified restriction predicates.
<X> JpaCteCriteria<X>	with(AbstractQuery<X> criteria)	Registers the given CriteriaQuery and returns a JpaCteCriteria, which can be used for querying.
<X> JpaCteCriteria<X>	with(String name, AbstractQuery<X> criteria)	Like JpaCteContainer.with(AbstractQuery) but assigns an explicit CTE name.
<X> JpaCteCriteria<X>	withRecursiveUnionAll(AbstractQuery<X> baseCriteria, Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)	Allows to register a recursive CTE.
<X> JpaCteCriteria<X>	withRecursiveUnionAll(String name, AbstractQuery<X> baseCriteria, Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)	Like JpaCteContainer.withRecursiveUnionAll(AbstractQuery, Function) but assigns an explicit CTE name.
<X> JpaCteCriteria<X>	withRecursiveUnionDistinct(AbstractQuery<X> baseCriteria, Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)	Allows to register a recursive CTE.
<X> JpaCteCriteria<X>	withRecursiveUnionDistinct(String name, AbstractQuery<X> baseCriteria, Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)	Like JpaCteContainer.withRecursiveUnionDistinct(AbstractQuery, Function) but assigns an explicit CTE name.

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmNode

nodeBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.criteria.JpaCriteriaBase

subquery

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectQuery

copy

Constructor Details

AbstractSqmSelectQuery

public AbstractSqmSelectQuery(Class<T> resultType,
 NodeBuilder builder)

AbstractSqmSelectQuery

public AbstractSqmSelectQuery(SqmQueryPart<T> queryPart,
 Class<T> resultType,
 NodeBuilder builder)

AbstractSqmSelectQuery

protected AbstractSqmSelectQuery(NodeBuilder builder,
 Map<String,SqmCteStatement<?>> cteStatements,
 Class<T> resultType)

AbstractSqmSelectQuery

public AbstractSqmSelectQuery(SqmQueryPart<T> queryPart,
 Map<String,SqmCteStatement<?>> cteStatements,
 Class<T> resultType,
 NodeBuilder builder)

Method Details

copyCteStatements

protected Map<String,SqmCteStatement<?>> copyCteStatements(SqmCopyContext context)

getCteStatements

public Collection<SqmCteStatement<?>> getCteStatements()

Specified by:

getCteStatements in interface SqmCteContainer

getCteStatement

public SqmCteStatement<?> getCteStatement(String cteLabel)

Specified by:

getCteStatement in interface SqmCteContainer

getCteCriterias

public Collection<? extends JpaCteCriteria<?>> getCteCriterias()

Description copied from interface: JpaCteContainer

Returns the CTEs that are registered on this container.

Specified by:

getCteCriterias in interface JpaCteContainer

getCteCriteria

public <X> JpaCteCriteria<X> getCteCriteria(String cteName)

Description copied from interface: JpaCteContainer

Returns a CTE that is registered by the given name on this container, or any of its parents.

Specified by:

getCteCriteria in interface JpaCteContainer

with

public <X> JpaCteCriteria<X> with(AbstractQuery<X> criteria)

Description copied from interface: JpaCteContainer

Registers the given CriteriaQuery and returns a JpaCteCriteria, which can be used for querying.

Specified by:

with in interface JpaCteContainer

See Also:

• JpaSelectCriteria.from(JpaCteCriteria)
• JpaFrom.join(JpaCteCriteria, SqmJoinType)

withRecursiveUnionAll

public <X> JpaCteCriteria<X> withRecursiveUnionAll(AbstractQuery<X> baseCriteria,
 Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)

Description copied from interface: JpaCteContainer

Allows to register a recursive CTE. The base CriteriaQuery serves for the structure of the JpaCteCriteria, which is made available in the recursive criteria producer function, so that the recursive CriteriaQuery is able to refer to the CTE again.

Specified by:

withRecursiveUnionAll in interface JpaCteContainer

See Also:

• JpaSelectCriteria.from(JpaCteCriteria)
• JpaFrom.join(JpaCteCriteria, SqmJoinType)

withRecursiveUnionDistinct

public <X> JpaCteCriteria<X> withRecursiveUnionDistinct(AbstractQuery<X> baseCriteria,
 Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)

Description copied from interface: JpaCteContainer

Allows to register a recursive CTE. The base CriteriaQuery serves for the structure of the JpaCteCriteria, which is made available in the recursive criteria producer function, so that the recursive CriteriaQuery is able to refer to the CTE again.

Specified by:

withRecursiveUnionDistinct in interface JpaCteContainer

See Also:

• JpaSelectCriteria.from(JpaCteCriteria)
• JpaFrom.join(JpaCteCriteria, SqmJoinType)

with

public <X> JpaCteCriteria<X> with(String name,
 AbstractQuery<X> criteria)

Description copied from interface: JpaCteContainer

Like JpaCteContainer.with(AbstractQuery) but assigns an explicit CTE name.

Specified by:

with in interface JpaCteContainer

withRecursiveUnionAll

public <X> JpaCteCriteria<X> withRecursiveUnionAll(String name,
 AbstractQuery<X> baseCriteria,
 Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)

Description copied from interface: JpaCteContainer

Like JpaCteContainer.withRecursiveUnionAll(AbstractQuery, Function) but assigns an explicit CTE name.

Specified by:

withRecursiveUnionAll in interface JpaCteContainer

withRecursiveUnionDistinct

public <X> JpaCteCriteria<X> withRecursiveUnionDistinct(String name,
 AbstractQuery<X> baseCriteria,
 Function<JpaCteCriteria<X>,AbstractQuery<X>> recursiveCriteriaProducer)

Description copied from interface: JpaCteContainer

Like JpaCteContainer.withRecursiveUnionDistinct(AbstractQuery, Function) but assigns an explicit CTE name.

Specified by:

withRecursiveUnionDistinct in interface JpaCteContainer

getResultType

public Class<T> getResultType()

Description copied from interface: AbstractQuery

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 will be returned. If the query was created using the createTupleQuery method, the result type is Tuple. Otherwise, the result type is Object.

Specified by:

getResultType in interface AbstractQuery<T>

Returns:

result type

setResultType

@Deprecated(forRemoval=true)
protected void setResultType(Class<T> resultType)

Deprecated, for removal: This API element is subject to removal in a future version.

Don't use this method. It has no effect.

getQuerySpec

public SqmQuerySpec<T> getQuerySpec()

Description copied from interface: JpaSelectCriteria

The query structure. See JpaQueryStructure for details

Specified by:

getQuerySpec in interface JpaSelectCriteria<T>

Specified by:

getQuerySpec in interface SqmSelectQuery<T>

getQueryPart

public SqmQueryPart<T> getQueryPart()

Description copied from interface: JpaSelectCriteria

The query structure. See JpaQueryStructure for details

Specified by:

getQueryPart in interface JpaSelectCriteria<T>

Specified by:

getQueryPart in interface SqmSelectQuery<T>

setQueryPart

public void setQueryPart(SqmQueryPart<T> sqmQueryPart)

getRoots

public Set<Root<?>> getRoots()

Description copied from interface: AbstractQuery

Return the query roots. These are the roots that have been defined for the 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.

Specified by:

getRoots in interface AbstractQuery<T>

Returns:

the set of query roots

getRootList

public List<Root<?>> getRootList()

from

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

Description copied from interface: AbstractQuery

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

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

Parameters:

entityClass - the entity class

Returns:

query root corresponding to the given entity

from

public <X> SqmDerivedRoot<X> from(Subquery<X> subquery)

Description copied from interface: JpaSelectCriteria

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

Specified by:

from in interface JpaSelectCriteria<T>

Parameters:

subquery - the subquery

Returns:

query root corresponding to the given subquery

from

public <X> JpaRoot<X> from(JpaCteCriteria<X> cte)

Description copied from interface: JpaSelectCriteria

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

Specified by:

from in interface JpaSelectCriteria<T>

Parameters:

cte - the cte criteria

Returns:

query root corresponding to the given cte

from

public <X> SqmRoot<X> from(EntityType<X> entityType)

Description copied from interface: AbstractQuery

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

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

Parameters:

entityType - metamodel entity representing the entity of type X

Returns:

query root corresponding to the given entity

isDistinct

public boolean isDistinct()

Description copied from interface: AbstractQuery

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

distinct

public SqmSelectQuery<T> distinct(boolean distinct)

Description copied from interface: AbstractQuery

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.

Specified by:

distinct in interface AbstractQuery<T>

Specified by:

distinct in interface JpaSelectCriteria<T>

Specified by:

distinct in interface SqmSelectQuery<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

public JpaSelection<T> getSelection()

Description copied from interface: AbstractQuery

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

Specified by:

getSelection in interface AbstractQuery<T>

Specified by:

getSelection in interface JpaSelectCriteria<T>

Returns:

selection item

getRestriction

public SqmPredicate getRestriction()

Description copied from interface: CommonAbstractCriteria

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

Specified by:

getRestriction in interface CommonAbstractCriteria

Specified by:

getRestriction in interface JpaCriteriaBase

Specified by:

getRestriction in interface JpaSelectCriteria<T>

Returns:

where clause predicate

where

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

Description copied from interface: AbstractQuery

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

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

where

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

Description copied from interface: AbstractQuery

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.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

getGroupList

public List<Expression<?>> getGroupList()

Description copied from interface: AbstractQuery

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.

Specified by:

getGroupList in interface AbstractQuery<T>

Returns:

the list of grouping expressions

groupBy

public SqmSelectQuery<T> groupBy(Expression<?>... expressions)

Description copied from interface: AbstractQuery

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>

Specified by:

groupBy in interface JpaSelectCriteria<T>

Parameters:

expressions - zero or more grouping expressions

Returns:

the modified query

groupBy

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

Description copied from interface: AbstractQuery

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>

Specified by:

groupBy in interface JpaSelectCriteria<T>

Parameters:

grouping - list of zero or more grouping expressions

Returns:

the modified query

getGroupRestriction

public SqmPredicate getGroupRestriction()

Description copied from interface: AbstractQuery

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

Specified by:

getGroupRestriction in interface AbstractQuery<T>

Specified by:

getGroupRestriction in interface JpaSelectCriteria<T>

Returns:

having clause predicate

having

public SqmSelectQuery<T> having(Expression<Boolean> booleanExpression)

Description copied from interface: AbstractQuery

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

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

Parameters:

booleanExpression - a simple or compound boolean expression

Returns:

the modified query

having

public SqmSelectQuery<T> having(Predicate... predicates)

Description copied from interface: AbstractQuery

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.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

Parameters:

predicates - zero or more restriction predicates

Returns:

the modified query

appendHqlString

public void appendHqlString(StringBuilder sb)

getResultSelection

protected Selection<? extends T> getResultSelection(Selection<?>[] selections)