Class SqmSelectStatement<T>

java.lang.Object

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

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

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

All Implemented Interfaces:

AbstractQuery<T>, CommonAbstractCriteria, CriteriaQuery<T>, CriteriaSelect<T>, Serializable, JpaCriteriaBase, JpaCriteriaNode, JpaCriteriaQuery<T>, JpaCriteriaSelect<T>, JpaCteContainer, JpaQueryableCriteria<T>, JpaSelectCriteria<T>, org.hibernate.query.sqm.internal.ParameterCollector, SqmCteContainer, SqmSelectQuery<T>, SqmCacheable, SqmNode, SqmQuery<T>, SqmStatement<T>, SqmVisitableNode

public class SqmSelectStatement<T>
extends AbstractSqmSelectQuery<T>
implements JpaCriteriaQuery<T>, SqmStatement<T>, org.hibernate.query.sqm.internal.ParameterCollector

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface SqmStatement

SqmStatement.ParameterResolutions

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmSelectStatement(Class<T> resultJavaType, NodeBuilder nodeBuilder)
SqmSelectStatement(Class<T> resultJavaType, SqmQuerySource querySource, NodeBuilder nodeBuilder)
SqmSelectStatement(NodeBuilder nodeBuilder)
SqmSelectStatement(SqmQuerySource querySource, NodeBuilder nodeBuilder)
SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, Map<String, SqmCteStatement<?>> cteStatements, SqmQuerySource querySource, NodeBuilder builder)
SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, SqmQuerySource querySource, NodeBuilder builder)
SqmSelectStatement(SqmSelectStatement<T> original)
SqmSelectStatement(SqmSelectStatement<T> original, Class<T> resultType)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	addParameter(SqmParameter<?> parameter)
boolean	containsCollectionFetches()
SqmSelectStatement<T>	copy(SqmCopyContext context)
<X> SqmSelectStatement<X>	createCopy(SqmCopyContext context, Class<X> resultType)
SqmSelectStatement<Long>	createCountQuery()	A query that returns the number of results of this query.
SqmSelectStatement<Boolean>	createExistsQuery()	A query that returns true if this query has any results.
SqmSelectStatement<T>	distinct(boolean distinct)	Set whether duplicate query results are eliminated.
JpaCriteriaQuery<T>	fetch(Number fetch)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(Number fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
String	generateAlias()
NodeBuilder	getCriteriaBuilder()	Return the criteria builder that created this query.
JpaExpression<Number>	getFetch()	Return the query fetch expression.
FetchClauseType	getFetchClauseType()	Return the fetch clause type.
JpaExpression<Number>	getOffset()	Return the query offset expression.
List<Order>	getOrderList()
Set<ParameterExpression<?>>	getParameters()
SqmQuerySource	getQuerySource()
SqmQuerySpec<T>	getQuerySpec()	The query structure.
Set<SqmParameter<?>>	getSqmParameters()	Access to the (potentially still growing) collection of parameters for the statement.
SqmSelectStatement<T>	groupBy(Expression<?>... expressions)	Set the grouping expressions.
SqmSelectStatement<T>	groupBy(List<Expression<?>> grouping)	Set the grouping expressions.
SqmSelectStatement<T>	having(BooleanExpression... restrictions)	Set the group restriction.
SqmSelectStatement<T>	having(Expression<Boolean> booleanExpression)	Set the group restriction.
SqmSelectStatement<T>	having(List<? extends Expression<Boolean>> restrictions)	Set the group restriction.
SqmSelectStatement<T>	multiselect(Selection<?>... selections)	Deprecated.
SqmSelectStatement<T>	multiselect(List<Selection<?>> selectionList)	Deprecated.
JpaCriteriaQuery<T>	offset(Number offset)	Set the query offset.
JpaCriteriaQuery<T>	offset(JpaExpression<? extends Number> offset)	Set the query offset.
SqmSelectStatement<T>	orderBy(Order... orders)	Set the ordering expressions.
SqmSelectStatement<T>	orderBy(List<Order> orders)	Set the ordering expressions.
boolean	producesUniqueResults()
SqmStatement.ParameterResolutions	resolveParameters()
SqmSelectStatement<T>	select(Selection<? extends T> selection)	Set the query selection.
<U> SqmSubQuery<U>	subquery(EntityType<U> type)	Create a subquery for the given entity type.
<U> SqmSubQuery<U>	subquery(Class<U> type)	Create a subquery with the given result type.
boolean	usesDistinct()
void	validateResultType(Class<?> resultType)
SqmSelectStatement<T>	where(BooleanExpression... restrictions)	Set the restriction.
SqmSelectStatement<T>	where(Expression<Boolean> restriction)	Set the restriction.
SqmSelectStatement<T>	where(List<? extends Expression<Boolean>> restrictions)	Set the restriction.
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)

Methods inherited from class AbstractSqmSelectQuery

appendHqlString, cacheHashCode, copyCteStatements, equals, from, from, from, from, from, getCteCriteria, getCteCriterias, getCteStatement, getCteStatements, getGroupList, getGroupRestriction, getQueryPart, getRestriction, getResultSelection, getResultType, getRoot, getRoot, getRootList, getRoots, getSelection, hashCode, isCompatible, isDistinct, setQueryPart, with, with, withRecursiveUnionAll, withRecursiveUnionAll, withRecursiveUnionDistinct, withRecursiveUnionDistinct

Methods inherited from class AbstractSqmNode

nodeBuilder

Methods inherited from class Object

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

Methods inherited from interface AbstractQuery

getGroupList, getResultType, getRoots, isDistinct

Methods inherited from interface JpaCriteriaQuery

from, from, getRoot, getRoot, getRootList

Methods inherited from interface JpaCteContainer

getCteCriteria, getCteCriterias, with, with, withRecursiveUnionAll, withRecursiveUnionAll, withRecursiveUnionDistinct, withRecursiveUnionDistinct

Methods inherited from interface JpaSelectCriteria

from, from, from, getGroupRestriction, getRestriction, getSelection

Methods inherited from interface SqmCacheable

cacheHashCode, isCompatible

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmVisitableNode

appendHqlString, toHqlString

Constructor Details

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 NodeBuilder nodeBuilder)

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 SqmQuerySource querySource,
 @Nonnull
 NodeBuilder nodeBuilder)

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 Class<T> resultJavaType,
 @Nonnull
 SqmQuerySource querySource,
 @Nonnull
 NodeBuilder nodeBuilder)

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 SqmQueryPart<T> queryPart,
 @Nonnull
 Class<T> resultType,
 @Nonnull
 SqmQuerySource querySource,
 @Nonnull
 NodeBuilder builder)

SqmSelectStatement

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

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 Class<T> resultJavaType,
 @Nonnull
 NodeBuilder nodeBuilder)

Implementation Note:

This form is used from the criteria query API.

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 SqmSelectStatement<T> original)

Implementation Note:

This form is used when transforming HQL to criteria. All it does is change the SqmQuerySource to CRITERIA in order to allow correct parameter handing.

SqmSelectStatement

public SqmSelectStatement(@Nonnull
 SqmSelectStatement<T> original,
 @Nonnull
 Class<T> resultType)

Implementation Note:

This form is used when transforming HQL to criteria with an explicit result type. All it does is change the SqmQuerySource to CRITERIA in order to allow correct parameter handing.

Method Details

copy

@Nonnull
public SqmSelectStatement<T> copy(@Nonnull
 SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmQuery<T>

Specified by:

copy in interface SqmSelectQuery<T>

Specified by:

copy in interface SqmStatement<T>

createCopy

@Nonnull
@Internal
public <X> SqmSelectStatement<X> createCopy(@Nonnull
 SqmCopyContext context,
 @Nonnull
 Class<X> resultType)

validateResultType

public void validateResultType(@Nullable
 Class<?> resultType)

getCriteriaBuilder

@Nonnull
public NodeBuilder getCriteriaBuilder()

Description copied from interface: JpaCriteriaQuery

Return the criteria builder that created this query.

Specified by:

getCriteriaBuilder in interface JpaCriteriaQuery<T>

getOrderList

@Nonnull
public List<Order> getOrderList()

Specified by:

getOrderList in interface CriteriaQuery<T>

getQuerySource

@Nonnull
public SqmQuerySource getQuerySource()

Specified by:

getQuerySource in interface SqmStatement<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>

Overrides:

getQuerySpec in class AbstractSqmSelectQuery<T>

producesUniqueResults

public boolean producesUniqueResults()

containsCollectionFetches

public boolean containsCollectionFetches()

usesDistinct

public boolean usesDistinct()

getSqmParameters

@Nonnull
public Set<SqmParameter<?>> getSqmParameters()

Description copied from interface: SqmStatement

Access to the (potentially still growing) collection of parameters for the statement.

Specified by:

getSqmParameters in interface SqmStatement<T>

resolveParameters

@Nonnull
public SqmStatement.ParameterResolutions resolveParameters()

Specified by:

resolveParameters in interface SqmStatement<T>

accept

@Nullable
public <X> X accept(@Nonnull
 SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

addParameter

public void addParameter(@Nonnull
 SqmParameter<?> parameter)

Specified by:

addParameter in interface org.hibernate.query.sqm.internal.ParameterCollector

withInternal

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

Overrides:

withInternal in class AbstractSqmSelectQuery<T>

withInternal

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

Overrides:

withInternal in class AbstractSqmSelectQuery<T>

distinct

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

distinct in interface JpaCriteriaQuery<T>

Specified by:

distinct in interface JpaSelectCriteria<T>

Specified by:

distinct in interface SqmSelectQuery<T>

Overrides:

distinct in class AbstractSqmSelectQuery<T>

getParameters

@Nonnull
public Set<ParameterExpression<?>> getParameters()

Description copied from interface: JpaCriteriaQuery

Specified by:

getParameters in interface CommonAbstractCriteria

Specified by:

getParameters in interface JpaCriteriaQuery<T>

subquery

@Nonnull
public <U> SqmSubQuery<U> subquery(@Nonnull
 EntityType<U> type)

Description copied from interface: JpaCriteriaQuery

Create a subquery for the given entity type.

Specified by:

subquery in interface CommonAbstractCriteria

Specified by:

subquery in interface JpaCriteriaQuery<T>

select

@Nonnull
public SqmSelectStatement<T> select(@Nonnull
 Selection<? extends T> selection)

Description copied from interface: JpaCriteriaQuery

Set the query selection.

Specified by:

select in interface CriteriaQuery<T>

Specified by:

select in interface JpaCriteriaQuery<T>

multiselect

@Nonnull
@Deprecated
public SqmSelectStatement<T> multiselect(@Nonnull
 Selection<?>... selections)

Deprecated.

Description copied from interface: JpaCriteriaQuery

Set the compound query selection.

Specified by:

multiselect in interface CriteriaQuery<T>

Specified by:

multiselect in interface JpaCriteriaQuery<T>

multiselect

@Nonnull
@Deprecated
public SqmSelectStatement<T> multiselect(@Nonnull
 List<Selection<?>> selectionList)

Deprecated.

Description copied from interface: JpaCriteriaQuery

Set the compound query selection.

Specified by:

multiselect in interface CriteriaQuery<T>

Specified by:

multiselect in interface JpaCriteriaQuery<T>

orderBy

@Nonnull
public SqmSelectStatement<T> orderBy(@Nonnull
 Order... orders)

Description copied from interface: JpaCriteriaQuery

Set the ordering expressions.

Specified by:

orderBy in interface CriteriaQuery<T>

Specified by:

orderBy in interface JpaCriteriaQuery<T>

orderBy

@Nonnull
public SqmSelectStatement<T> orderBy(@Nonnull
 List<Order> orders)

Description copied from interface: JpaCriteriaQuery

Set the ordering expressions.

Specified by:

orderBy in interface CriteriaQuery<T>

Specified by:

orderBy in interface JpaCriteriaQuery<T>

subquery

@Nonnull
public <U> SqmSubQuery<U> subquery(@Nonnull
 Class<U> type)

Description copied from interface: JpaCriteriaBase

Create a subquery with the given result type.

Specified by:

subquery in interface CommonAbstractCriteria

Specified by:

subquery in interface JpaCriteriaBase

where

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

where in interface JpaCriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

Overrides:

where in class AbstractSqmSelectQuery<T>

where

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

where in interface JpaCriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

Overrides:

where in class AbstractSqmSelectQuery<T>

where

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

where in interface JpaCriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

Overrides:

where in class AbstractSqmSelectQuery<T>

groupBy

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

groupBy in interface JpaCriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

Overrides:

groupBy in class AbstractSqmSelectQuery<T>

groupBy

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

groupBy in interface JpaCriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

Overrides:

groupBy in class AbstractSqmSelectQuery<T>

having

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

having in interface JpaCriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

Overrides:

having in class AbstractSqmSelectQuery<T>

having

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

having in interface JpaCriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

Overrides:

having in class AbstractSqmSelectQuery<T>

having

@Nonnull
public SqmSelectStatement<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 CriteriaQuery<T>

Specified by:

having in interface JpaCriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

Overrides:

having in class AbstractSqmSelectQuery<T>

getOffset

@Nullable
public JpaExpression<Number> getOffset()

Description copied from interface: JpaCriteriaQuery

Return the query offset expression.

Specified by:

getOffset in interface JpaCriteriaQuery<T>

offset

@Nonnull
public JpaCriteriaQuery<T> offset(@Nullable
 JpaExpression<? extends Number> offset)

Description copied from interface: JpaCriteriaQuery

Set the query offset.

Specified by:

offset in interface JpaCriteriaQuery<T>

offset

@Nonnull
public JpaCriteriaQuery<T> offset(@Nullable
 Number offset)

Description copied from interface: JpaCriteriaQuery

Set the query offset.

Specified by:

offset in interface JpaCriteriaQuery<T>

getFetch

@Nullable
public JpaExpression<Number> getFetch()

Description copied from interface: JpaCriteriaQuery

Return the query fetch expression.

Specified by:

getFetch in interface JpaCriteriaQuery<T>

fetch

@Nonnull
public JpaCriteriaQuery<T> fetch(@Nullable
 JpaExpression<? extends Number> fetch)

Description copied from interface: JpaCriteriaQuery

Set the query fetch limit.

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

@Nonnull
public JpaCriteriaQuery<T> fetch(@Nullable
 JpaExpression<? extends Number> fetch,
 @Nonnull
 FetchClauseType fetchClauseType)

Description copied from interface: JpaCriteriaQuery

Set the query fetch limit.

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

@Nonnull
public JpaCriteriaQuery<T> fetch(@Nullable
 Number fetch)

Description copied from interface: JpaCriteriaQuery

Set the query fetch limit.

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

@Nonnull
public JpaCriteriaQuery<T> fetch(@Nullable
 Number fetch,
 @Nonnull
 FetchClauseType fetchClauseType)

Description copied from interface: JpaCriteriaQuery

Set the query fetch limit.

Specified by:

fetch in interface JpaCriteriaQuery<T>

getFetchClauseType

@Nonnull
public FetchClauseType getFetchClauseType()

Description copied from interface: JpaCriteriaQuery

Return the fetch clause type.

Specified by:

getFetchClauseType in interface JpaCriteriaQuery<T>

createCountQuery

@Nonnull
public SqmSelectStatement<Long> createCountQuery()

Description copied from interface: JpaCriteriaQuery

A query that returns the number of results of this query.

Specified by:

createCountQuery in interface JpaCriteriaQuery<T>

See Also:

• SelectionQuery.getResultCount()

createExistsQuery

@Nonnull
public SqmSelectStatement<Boolean> createExistsQuery()

Description copied from interface: JpaCriteriaQuery

A query that returns true if this query has any results.

Specified by:

createExistsQuery in interface JpaCriteriaQuery<T>

generateAlias

@Nonnull
public String generateAlias()

Specified by:

generateAlias in interface SqmQuery<T>