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

Class SqmSelectStatement<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

org.hibernate.query.sqm.tree.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>, ParameterCollector, SqmCteContainer, SqmSelectQuery<T>, SqmNode, SqmQuery<T>, SqmStatement<T>, SqmVisitableNode

public class SqmSelectStatement<T>
extends AbstractSqmSelectQuery<T>
implements JpaCriteriaQuery<T>, SqmStatement<T>, ParameterCollector

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.sqm.tree.SqmStatement

SqmStatement.ParameterResolutions

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.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)

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)
JpaCriteriaQuery<T>	fetch(Number fetch)
JpaCriteriaQuery<T>	fetch(Number fetch, FetchClauseType fetchClauseType)
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch)
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)
String	generateAlias()
NodeBuilder	getCriteriaBuilder()
JpaExpression<Number>	getFetch()
FetchClauseType	getFetchClauseType()
JpaExpression<Number>	getOffset()
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)
SqmSelectStatement<T>	groupBy(List<Expression<?>> grouping)
SqmSelectStatement<T>	having(Expression<Boolean> booleanExpression)
SqmSelectStatement<T>	having(Predicate... predicates)
SqmSelectStatement<T>	having(List<Predicate> restrictions)
SqmSelectStatement<T>	multiselect(Selection<?>... selections)	Deprecated.
SqmSelectStatement<T>	multiselect(List<Selection<?>> selectionList)	Deprecated.
JpaCriteriaQuery<T>	offset(Number offset)
JpaCriteriaQuery<T>	offset(JpaExpression<? extends Number> offset)
SqmSelectStatement<T>	orderBy(Order... orders)
SqmSelectStatement<T>	orderBy(List<Order> orders)
boolean	producesUniqueResults()
SqmStatement.ParameterResolutions	resolveParameters()
SqmSelectStatement<T>	select(Selection<? extends T> selection)
<U> SqmSubQuery<U>	subquery(EntityType<U> type)
<U> SqmSubQuery<U>	subquery(Class<U> type)
boolean	usesDistinct()
void	validateResultType(Class<?> resultType)
SqmSelectStatement<T>	where(Expression<Boolean> restriction)
SqmSelectStatement<T>	where(Predicate... restrictions)
SqmSelectStatement<T>	where(List<Predicate> restrictions)
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 org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery

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

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

nodeBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.persistence.criteria.AbstractQuery

getGroupList, getResultType, getRoots, isDistinct

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

from, from, getRoot, getRoot, getRootList

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

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

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

from, from, from, getGroupRestriction, getRestriction, getSelection

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

asLoggableText, nodeBuilder

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

appendHqlString, toHqlString

Constructor Details

SqmSelectStatement

public SqmSelectStatement(NodeBuilder nodeBuilder)

SqmSelectStatement

public SqmSelectStatement(SqmQuerySource querySource,
 NodeBuilder nodeBuilder)

SqmSelectStatement

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

SqmSelectStatement

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

SqmSelectStatement

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

SqmSelectStatement

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

Implementation Note:

This form is used from the criteria query API.

SqmSelectStatement

public SqmSelectStatement(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.

Method Details

copy

public SqmSelectStatement<T> copy(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

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

validateResultType

public void validateResultType(Class<?> resultType)

getCriteriaBuilder

public NodeBuilder getCriteriaBuilder()

Specified by:

getCriteriaBuilder in interface JpaCriteriaQuery<T>

getOrderList

public List<Order> getOrderList()

Specified by:

getOrderList in interface CriteriaQuery<T>

getQuerySource

public SqmQuerySource getQuerySource()

Specified by:

getQuerySource in interface SqmStatement<T>

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>

Overrides:

getQuerySpec in class AbstractSqmSelectQuery<T>

producesUniqueResults

public boolean producesUniqueResults()

containsCollectionFetches

public boolean containsCollectionFetches()

usesDistinct

public boolean usesDistinct()

getSqmParameters

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

public SqmStatement.ParameterResolutions resolveParameters()

Specified by:

resolveParameters in interface SqmStatement<T>

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

addParameter

public void addParameter(SqmParameter<?> parameter)

Specified by:

addParameter in interface ParameterCollector

withInternal

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

Overrides:

withInternal in class AbstractSqmSelectQuery<T>

withInternal

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

Overrides:

withInternal in class AbstractSqmSelectQuery<T>

distinct

public SqmSelectStatement<T> distinct(boolean distinct)

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

public Set<ParameterExpression<?>> getParameters()

Description copied from interface: JpaCriteriaQuery

Specified by:

getParameters in interface CommonAbstractCriteria

Specified by:

getParameters in interface JpaCriteriaQuery<T>

subquery

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

Specified by:

subquery in interface CommonAbstractCriteria

Specified by:

subquery in interface JpaCriteriaQuery<T>

select

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

Specified by:

select in interface CriteriaQuery<T>

Specified by:

select in interface JpaCriteriaQuery<T>

multiselect

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

Deprecated.

Specified by:

multiselect in interface CriteriaQuery<T>

Specified by:

multiselect in interface JpaCriteriaQuery<T>

multiselect

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

Deprecated.

Specified by:

multiselect in interface CriteriaQuery<T>

Specified by:

multiselect in interface JpaCriteriaQuery<T>

orderBy

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

Specified by:

orderBy in interface CriteriaQuery<T>

Specified by:

orderBy in interface JpaCriteriaQuery<T>

orderBy

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

Specified by:

orderBy in interface CriteriaQuery<T>

Specified by:

orderBy in interface JpaCriteriaQuery<T>

subquery

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

Specified by:

subquery in interface CommonAbstractCriteria

Specified by:

subquery in interface JpaCriteriaBase

where

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

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

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

public SqmSelectStatement<T> where(List<Predicate> restrictions)

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaCriteriaQuery<T>

Overrides:

where in class AbstractSqmSelectQuery<T>

groupBy

public SqmSelectStatement<T> groupBy(Expression<?>... 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

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

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

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

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

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

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

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

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaCriteriaQuery<T>

Overrides:

having in class AbstractSqmSelectQuery<T>

getOffset

public JpaExpression<Number> getOffset()

Specified by:

getOffset in interface JpaCriteriaQuery<T>

offset

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

Specified by:

offset in interface JpaCriteriaQuery<T>

offset

public JpaCriteriaQuery<T> offset(Number offset)

Specified by:

offset in interface JpaCriteriaQuery<T>

getFetch

public JpaExpression<Number> getFetch()

Specified by:

getFetch in interface JpaCriteriaQuery<T>

fetch

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

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

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

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

public JpaCriteriaQuery<T> fetch(Number fetch)

Specified by:

fetch in interface JpaCriteriaQuery<T>

fetch

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

Specified by:

fetch in interface JpaCriteriaQuery<T>

getFetchClauseType

public FetchClauseType getFetchClauseType()

Specified by:

getFetchClauseType in interface JpaCriteriaQuery<T>

createCountQuery

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

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

public String generateAlias()

Specified by:

generateAlias in interface SqmQuery<T>