Class AbstractSqmSelectQuery<T>

java.lang.Object

org.hibernate.query.sqm.tree.spi.AbstractSqmNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SqmSelectStatement, SqmSubQuery

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

See Also:

• Serialized Form

Field Summary

Fields inherited from interface 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 hql, SqmRenderContext context)
int	cacheHashCode()
protected Map<String, SqmCteStatement<?>>	copyCteStatements(SqmCopyContext context)
SqmSelectQuery<T>	distinct(boolean distinct)	Set whether duplicate query results are eliminated.
boolean	equals(Object object)
<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 a query root for the given entity type.
<X> SqmRoot<X>	from(Class<X> entityClass)	Create a query root for the given entity type.
<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> JpaFunctionRoot<X>	from(JpaSetReturningFunction<X> function)	Create and add a query root corresponding to the given set-returning function, 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()
SqmPredicate	getGroupRestriction()	Return the group restriction.
SqmQueryPart<T>	getQueryPart()	The query structure.
SqmQuerySpec<T>	getQuerySpec()	The query structure.
SqmPredicate	getRestriction()	Return the restriction predicate.
protected Selection<? extends T>	getResultSelection(Selection<?>[] selections)
Class<T>	getResultType()
<E> JpaRoot<? extends E>	getRoot(int position, Class<E> type)
<E> JpaRoot<? extends E>	getRoot(String alias, Class<E> type)
List<Root<?>>	getRootList()
Set<Root<?>>	getRoots()
JpaSelection<T>	getSelection()	Return the query selection.
SqmSelectQuery<T>	groupBy(Expression<?>... expressions)	Set the grouping expressions.
SqmSelectQuery<T>	groupBy(List<Expression<?>> grouping)	Set the grouping expressions.
int	hashCode()
JpaSelectCriteria<T>	having(BooleanExpression... restrictions)	Set the group restriction.
SqmSelectQuery<T>	having(Expression<Boolean> booleanExpression)	Set the group restriction.
JpaSelectCriteria<T>	having(List<? extends Expression<Boolean>> restrictions)	Set the group restriction.
boolean	isCompatible(Object object)
boolean	isDistinct()
void	setQueryPart(SqmQueryPart<T> sqmQueryPart)
SqmSelectQuery<T>	where(BooleanExpression... restrictions)	Set the restriction.
SqmSelectQuery<T>	where(Expression<Boolean> restriction)	Set the restriction.
JpaSelectCriteria<T>	where(List<? extends Expression<Boolean>> restrictions)	Set the restriction.
<X> JpaCteCriteria<X>	with(AbstractQuery<X> criteria)	Deprecated.
<X> JpaCteCriteria<X>	with(String name, AbstractQuery<X> criteria)	Like JpaCteContainer.with(AbstractQuery) but assigns an explicit CTE name.
protected <X> JpaCteCriteria<X>	withInternal(String name, AbstractQuery<X> criteria)
protected <X> JpaCteCriteria<X>	withInternal(String name, AbstractQuery<X> baseCriteria, boolean unionDistinct, Function<JpaCteCriteria<X>, AbstractQuery<X>> recursiveCriteriaProducer)
<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 AbstractSqmNode

nodeBuilder

Methods inherited from class Object

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

Methods inherited from interface CommonAbstractCriteria

getParameters, subquery

Methods inherited from interface JpaCriteriaBase

subquery

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmQuery

generateAlias

Methods inherited from interface SqmSelectQuery

copy

Constructor Details

AbstractSqmSelectQuery

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

AbstractSqmSelectQuery

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

AbstractSqmSelectQuery

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

AbstractSqmSelectQuery

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

Method Details

copyCteStatements

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

getCteStatements

@Nonnull
public Collection<SqmCteStatement<?>> getCteStatements()

Specified by:

getCteStatements in interface SqmCteContainer

getCteStatement

@Nullable
public SqmCteStatement<?> getCteStatement(@Nonnull
 String cteLabel)

Specified by:

getCteStatement in interface SqmCteContainer

getCteCriterias

@Nonnull
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

@Nullable
public <X> JpaCteCriteria<X> getCteCriteria(@Nonnull
 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

@Deprecated
@Nonnull
public <X> JpaCteCriteria<X> with(@Nonnull
 AbstractQuery<X> criteria)

Deprecated.

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)

withRecursiveUnionAll

@Nonnull
public <X> JpaCteCriteria<X> withRecursiveUnionAll(@Nonnull
 AbstractQuery<X> baseCriteria,
 @Nonnull
 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)

withRecursiveUnionDistinct

@Nonnull
public <X> JpaCteCriteria<X> withRecursiveUnionDistinct(@Nonnull
 AbstractQuery<X> baseCriteria,
 @Nonnull
 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)

with

@Nonnull
public <X> JpaCteCriteria<X> with(@Nonnull
 String name,
 @Nonnull
 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

@Nonnull
public <X> JpaCteCriteria<X> withRecursiveUnionAll(@Nonnull
 String name,
 @Nonnull
 AbstractQuery<X> baseCriteria,
 @Nonnull
 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

@Nonnull
public <X> JpaCteCriteria<X> withRecursiveUnionDistinct(@Nonnull
 String name,
 @Nonnull
 AbstractQuery<X> baseCriteria,
 @Nonnull
 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

withInternal

@Nonnull
protected <X> JpaCteCriteria<X> withInternal(@Nonnull
 String name,
 @Nonnull
 AbstractQuery<X> criteria)

withInternal

@Nonnull
protected <X> JpaCteCriteria<X> withInternal(@Nonnull
 String name,
 @Nonnull
 AbstractQuery<X> baseCriteria,
 boolean unionDistinct,
 @Nonnull
 Function<JpaCteCriteria<X>, AbstractQuery<X>> recursiveCriteriaProducer)

getResultType

@Nonnull
public Class<T> getResultType()

Specified by:

getResultType in interface AbstractQuery<T>

getQuerySpec

@Nonnull
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

@Nonnull
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(@Nonnull
 SqmQueryPart<T> sqmQueryPart)

getRoots

@Nonnull
public Set<Root<?>> getRoots()

Specified by:

getRoots in interface AbstractQuery<T>

getRootList

@Nonnull
public List<Root<?>> getRootList()

Specified by:

getRootList in interface AbstractQuery<T>

See Also:

• JpaCriteriaQuery.getRootList()

getRoot

@Nonnull
public <E> JpaRoot<? extends E> getRoot(int position,
 @Nonnull
 Class<E> type)

See Also:

• JpaCriteriaQuery.getRoot(int, Class)

getRoot

@Nonnull
public <E> JpaRoot<? extends E> getRoot(@Nonnull
 String alias,
 @Nonnull
 Class<E> type)

See Also:

• JpaCriteriaQuery.getRoot(String, Class)

from

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

Description copied from interface: JpaSelectCriteria

Create a query root for the given entity type.

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

from

@Nonnull
public <X> SqmDerivedRoot<X> from(@Nonnull
 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

@Nonnull
public <X> JpaRoot<X> from(@Nonnull
 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

@Nonnull
public <X> JpaFunctionRoot<X> from(@Nonnull
 JpaSetReturningFunction<X> function)

Description copied from interface: JpaSelectCriteria

Create and add a query root corresponding to the given set-returning function, forming a cartesian product with any existing roots.

Specified by:

from in interface JpaSelectCriteria<T>

Parameters:

function - the set-returning function

Returns:

query root corresponding to the given function

from

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

Description copied from interface: JpaSelectCriteria

Create a query root for the given entity type.

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

isDistinct

public boolean isDistinct()

Specified by:

isDistinct in interface AbstractQuery<T>

distinct

@Nonnull
public SqmSelectQuery<T> distinct(boolean distinct)

Description copied from interface: JpaSelectCriteria

Set whether duplicate query results are eliminated.

Specified by:

distinct in interface AbstractQuery<T>

Specified by:

distinct in interface JpaSelectCriteria<T>

Specified by:

distinct in interface SqmSelectQuery<T>

getSelection

@Nullable
public JpaSelection<T> getSelection()

Description copied from interface: JpaSelectCriteria

Return the query selection.

Specified by:

getSelection in interface AbstractQuery<T>

Specified by:

getSelection in interface JpaSelectCriteria<T>

getRestriction

@Nullable
public SqmPredicate getRestriction()

Description copied from interface: JpaCriteriaBase

Return the restriction predicate.

Specified by:

getRestriction in interface CommonAbstractCriteria

Specified by:

getRestriction in interface JpaCriteriaBase

Specified by:

getRestriction in interface JpaSelectCriteria<T>

where

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

Description copied from interface: JpaSelectCriteria

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

@Nonnull
public SqmSelectQuery<T> where(@Nonnull
 BooleanExpression... restrictions)

Description copied from interface: JpaSelectCriteria

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

@Nonnull
public JpaSelectCriteria<T> where(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Description copied from interface: JpaSelectCriteria

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

getGroupList

@Nonnull
public List<Expression<?>> getGroupList()

Specified by:

getGroupList in interface AbstractQuery<T>

groupBy

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

Description copied from interface: JpaSelectCriteria

Set the grouping expressions.

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

groupBy

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

Description copied from interface: JpaSelectCriteria

Set the grouping expressions.

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

getGroupRestriction

@Nullable
public SqmPredicate getGroupRestriction()

Description copied from interface: JpaSelectCriteria

Return the group restriction.

Specified by:

getGroupRestriction in interface AbstractQuery<T>

Specified by:

getGroupRestriction in interface JpaSelectCriteria<T>

having

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

Description copied from interface: JpaSelectCriteria

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

@Nonnull
public JpaSelectCriteria<T> having(@Nonnull
 BooleanExpression... restrictions)

Description copied from interface: JpaSelectCriteria

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

@Nonnull
public JpaSelectCriteria<T> having(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Description copied from interface: JpaSelectCriteria

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(@Nullable
 Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

getResultSelection

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