Class SqmQuerySpec<T>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaQueryPart<T>, JpaQueryStructure<T>, SqmFromClauseContainer, SqmWhereClauseContainer, SqmCacheable, SqmNode, SqmVisitableNode

public class SqmQuerySpec<T>
extends SqmQueryPart<T>
implements SqmNode, SqmFromClauseContainer, SqmWhereClauseContainer, JpaQueryStructure<T>

Defines the commonality between a root query and a subquery.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmQuerySpec(NodeBuilder nodeBuilder)
SqmQuerySpec(SqmQuerySpec<T> original, SqmCopyContext context)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
SqmQuerySpec<T>	addRoot(JpaRoot<?> root)	Add a query root.
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
void	applyPredicate(SqmPredicate predicate)
int	cacheHashCode()
boolean	containsCollectionFetches()
SqmQuerySpec<T>	copy(SqmCopyContext context)
boolean	equals(Object object)
SqmQuerySpec<T>	getFirstQuerySpec()
SqmFromClause	getFromClause()	Obtains this container's SqmFromClause.
List<SqmExpression<?>>	getGroupByClauseExpressions()
List<SqmExpression<?>>	getGroupingExpressions()	Return the grouping expressions.
SqmPredicate	getGroupRestriction()	Return the group restriction.
SqmPredicate	getHavingClausePredicate()
SqmQuerySpec<T>	getLastQuerySpec()
SqmPredicate	getRestriction()	Set the restriction.
List<SqmRoot<?>>	getRootList()	Return the query roots as a list.
Set<SqmRoot<?>>	getRoots()	Return the query roots.
SqmSelectClause	getSelectClause()
JpaSelection<T>	getSelection()	Return the query selection.
SqmWhereClause	getWhereClause()
boolean	groupByClauseContains(NavigablePath navigablePath, SqmToSqlAstConverter sqlAstConverter)
int	hashCode()
boolean	hasPositionalGroupItem()
boolean	isCompatible(Object object)
boolean	isDistinct()	Return whether duplicate query results are eliminated.
boolean	isSimpleQueryPart()
boolean	orderByClauseContains(NavigablePath navigablePath, SqmToSqlAstConverter sqlAstConverter)
boolean	producesUniqueResults()
SqmQuerySpec<T>	setDistinct(boolean distinct)	Set whether duplicate query results are eliminated.
SqmQuerySpec<T>	setFetch(JpaExpression<? extends Number> fetch)	Set the query fetch limit.
SqmQuerySpec<T>	setFetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
void	setFromClause(SqmFromClause fromClause)
void	setGroupByClauseExpressions(List<SqmExpression<?>> groupByClauseExpressions)
SqmQuerySpec<T>	setGroupingExpressions(Expression<?>... groupExpressions)	Set the grouping expressions.
SqmQuerySpec<T>	setGroupingExpressions(List<? extends Expression<?>> groupExpressions)	Set the grouping expressions.
SqmQuerySpec<T>	setGroupRestriction(BooleanExpression... restrictions)	Set the group restriction.
SqmQuerySpec<T>	setGroupRestriction(Expression<Boolean> restriction)	Set the group restriction.
SqmQuerySpec<T>	setGroupRestriction(Predicate... restrictions)	Set the group restriction.
SqmQuerySpec<T>	setGroupRestriction(List<Predicate> restrictions)	Set the group restriction.
SqmQuerySpec<T>	setGroupRestriction(JpaPredicate restriction)	Set the group restriction.
void	setHavingClausePredicate(SqmPredicate havingClausePredicate)
SqmQuerySpec<T>	setOffset(JpaExpression<? extends Number> offset)	Set the query offset.
SqmQuerySpec<T>	setRestriction(BooleanExpression... restrictions)	Set the restriction.
SqmQuerySpec<T>	setRestriction(Expression<Boolean> restriction)	Set the restriction.
SqmQuerySpec<T>	setRestriction(Predicate... restrictions)	Set the restriction.
SqmQuerySpec<T>	setRestriction(List<Predicate> restrictions)	Set the restriction.
SqmQuerySpec<T>	setRestriction(JpaPredicate restriction)
void	setSelectClause(SqmSelectClause selectClause)
SqmQuerySpec<T>	setSelection(JpaSelection<T> selection)	Set the query selection.
SqmQuerySpec<T>	setSortSpecifications(List<? extends JpaOrder> sortSpecifications)	Set the ordering specifications.
void	setWhereClause(SqmWhereClause whereClause)
void	validateFetchOwners()
void	validateQueryStructureAndFetchOwners()
boolean	whereClauseContains(NavigablePath navigablePath, SqmToSqlAstConverter sqlAstConverter)

Methods inherited from class SqmQueryPart

copyTo, getFetch, getFetchClauseType, getFetchExpression, getOffset, getOffsetExpression, getOrderByClause, getSortSpecifications, nodeBuilder, setFetchExpression, setFetchExpression, setOffsetExpression, setOrderByClause

Methods inherited from class Object

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

Methods inherited from interface JpaQueryPart

getFetch, getFetchClauseType, getOffset, getSortSpecifications

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmVisitableNode

toHqlString

Constructor Details

SqmQuerySpec

public SqmQuerySpec(@Nonnull
 NodeBuilder nodeBuilder)

SqmQuerySpec

public SqmQuerySpec(@Nonnull
 SqmQuerySpec<T> original,
 @Nonnull
 SqmCopyContext context)

Method Details

copy

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

Specified by:

copy in interface SqmNode

Specified by:

copy in class SqmQueryPart<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

getFirstQuerySpec

@Nonnull
public SqmQuerySpec<T> getFirstQuerySpec()

Specified by:

getFirstQuerySpec in class SqmQueryPart<T>

getLastQuerySpec

@Nonnull
public SqmQuerySpec<T> getLastQuerySpec()

Specified by:

getLastQuerySpec in class SqmQueryPart<T>

isSimpleQueryPart

public boolean isSimpleQueryPart()

Specified by:

isSimpleQueryPart in class SqmQueryPart<T>

getFromClause

@Nonnull
public SqmFromClause getFromClause()

Description copied from interface: SqmFromClauseContainer

Obtains this container's SqmFromClause.

Specified by:

getFromClause in interface SqmFromClauseContainer

Returns:

This container's SqmFromClause.

setFromClause

public void setFromClause(@Nullable
 SqmFromClause fromClause)

producesUniqueResults

public boolean producesUniqueResults()

containsCollectionFetches

public boolean containsCollectionFetches()

getSelectClause

@Nonnull
public SqmSelectClause getSelectClause()

setSelectClause

public void setSelectClause(@Nonnull
 SqmSelectClause selectClause)

getWhereClause

@Nullable
public SqmWhereClause getWhereClause()

Specified by:

getWhereClause in interface SqmWhereClauseContainer

setWhereClause

public void setWhereClause(@Nullable
 SqmWhereClause whereClause)

applyPredicate

public void applyPredicate(@Nullable
 SqmPredicate predicate)

Specified by:

applyPredicate in interface SqmWhereClauseContainer

hasPositionalGroupItem

public boolean hasPositionalGroupItem()

getGroupByClauseExpressions

@Nonnull
public List<SqmExpression<?>> getGroupByClauseExpressions()

setGroupByClauseExpressions

public void setGroupByClauseExpressions(@Nullable
 List<SqmExpression<?>> groupByClauseExpressions)

getHavingClausePredicate

@Nullable
public SqmPredicate getHavingClausePredicate()

setHavingClausePredicate

public void setHavingClausePredicate(@Nullable
 SqmPredicate havingClausePredicate)

isDistinct

public boolean isDistinct()

Description copied from interface: JpaQueryStructure

Return whether duplicate query results are eliminated.

Specified by:

isDistinct in interface JpaQueryStructure<T>

setDistinct

@Nonnull
public SqmQuerySpec<T> setDistinct(boolean distinct)

Description copied from interface: JpaQueryStructure

Set whether duplicate query results are eliminated.

Specified by:

setDistinct in interface JpaQueryStructure<T>

getSelection

@Nonnull
public JpaSelection<T> getSelection()

Description copied from interface: JpaQueryStructure

Return the query selection.

Specified by:

getSelection in interface JpaQueryStructure<T>

setSelection

@Nonnull
public SqmQuerySpec<T> setSelection(@Nonnull
 JpaSelection<T> selection)

Description copied from interface: JpaQueryStructure

Set the query selection.

Specified by:

setSelection in interface JpaQueryStructure<T>

getRoots

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

Description copied from interface: JpaQueryStructure

Return the query roots.

Specified by:

getRoots in interface JpaQueryStructure<T>

getRootList

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

Description copied from interface: JpaQueryStructure

Return the query roots as a list.

Specified by:

getRootList in interface JpaQueryStructure<T>

addRoot

@Nonnull
public SqmQuerySpec<T> addRoot(@Nonnull
 JpaRoot<?> root)

Description copied from interface: JpaQueryStructure

Add a query root.

Specified by:

addRoot in interface JpaQueryStructure<T>

getRestriction

@Nullable
public SqmPredicate getRestriction()

Description copied from interface: JpaQueryStructure

Set the restriction.

Specified by:

getRestriction in interface JpaQueryStructure<T>

setRestriction

@Nonnull
public SqmQuerySpec<T> setRestriction(@Nullable
 JpaPredicate restriction)

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

@Nonnull
public SqmQuerySpec<T> setRestriction(@Nullable
 Expression<Boolean> restriction)

Description copied from interface: JpaQueryStructure

Set the restriction.

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

@Nonnull
public SqmQuerySpec<T> setRestriction(@Nonnull
 BooleanExpression... restrictions)

Description copied from interface: JpaQueryStructure

Set the restriction.

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

@Nonnull
public SqmQuerySpec<T> setRestriction(@Nonnull
 Predicate... restrictions)

Description copied from interface: JpaQueryStructure

Set the restriction.

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

@Nonnull
public SqmQuerySpec<T> setRestriction(@Nonnull
 List<Predicate> restrictions)

Description copied from interface: JpaQueryStructure

Set the restriction.

Specified by:

setRestriction in interface JpaQueryStructure<T>

getGroupingExpressions

@Nonnull
public List<SqmExpression<?>> getGroupingExpressions()

Description copied from interface: JpaQueryStructure

Return the grouping expressions.

Specified by:

getGroupingExpressions in interface JpaQueryStructure<T>

setGroupingExpressions

@Nonnull
public SqmQuerySpec<T> setGroupingExpressions(@Nonnull
 List<? extends Expression<?>> groupExpressions)

Description copied from interface: JpaQueryStructure

Set the grouping expressions.

Specified by:

setGroupingExpressions in interface JpaQueryStructure<T>

setGroupingExpressions

@Nonnull
public SqmQuerySpec<T> setGroupingExpressions(@Nonnull
 Expression<?>... groupExpressions)

Description copied from interface: JpaQueryStructure

Set the grouping expressions.

Specified by:

setGroupingExpressions in interface JpaQueryStructure<T>

getGroupRestriction

@Nullable
public SqmPredicate getGroupRestriction()

Description copied from interface: JpaQueryStructure

Return the group restriction.

Specified by:

getGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

@Nonnull
public SqmQuerySpec<T> setGroupRestriction(@Nullable
 JpaPredicate restriction)

Description copied from interface: JpaQueryStructure

Set the group restriction.

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

@Nonnull
public SqmQuerySpec<T> setGroupRestriction(@Nullable
 Expression<Boolean> restriction)

Description copied from interface: JpaQueryStructure

Set the group restriction.

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

@Nonnull
public SqmQuerySpec<T> setGroupRestriction(@Nullable
 Predicate... restrictions)

Description copied from interface: JpaQueryStructure

Set the group restriction.

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

@Nonnull
public SqmQuerySpec<T> setGroupRestriction(@Nullable
 BooleanExpression... restrictions)

Description copied from interface: JpaQueryStructure

Set the group restriction.

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

@Nonnull
public SqmQuerySpec<T> setGroupRestriction(@Nonnull
 List<Predicate> restrictions)

Description copied from interface: JpaQueryStructure

Set the group restriction.

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setSortSpecifications

@Nonnull
public SqmQuerySpec<T> setSortSpecifications(@Nonnull
 List<? extends JpaOrder> sortSpecifications)

Description copied from interface: JpaQueryPart

Set the ordering specifications.

Specified by:

setSortSpecifications in interface JpaQueryPart<T>

Specified by:

setSortSpecifications in interface JpaQueryStructure<T>

Overrides:

setSortSpecifications in class SqmQueryPart<T>

setOffset

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

Description copied from interface: JpaQueryPart

Set the query offset.

Specified by:

setOffset in interface JpaQueryPart<T>

Specified by:

setOffset in interface JpaQueryStructure<T>

Overrides:

setOffset in class SqmQueryPart<T>

setFetch

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

Description copied from interface: JpaQueryPart

Set the query fetch limit.

Specified by:

setFetch in interface JpaQueryPart<T>

Specified by:

setFetch in interface JpaQueryStructure<T>

Overrides:

setFetch in class SqmQueryPart<T>

setFetch

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

Description copied from interface: JpaQueryPart

Set the query fetch limit.

Specified by:

setFetch in interface JpaQueryPart<T>

Specified by:

setFetch in interface JpaQueryStructure<T>

Overrides:

setFetch in class SqmQueryPart<T>

validateQueryStructureAndFetchOwners

public void validateQueryStructureAndFetchOwners()

Specified by:

validateQueryStructureAndFetchOwners in class SqmQueryPart<T>

validateFetchOwners

public void validateFetchOwners()

appendHqlString

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

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmQueryPart<T>

whereClauseContains

@Internal
public boolean whereClauseContains(@Nonnull
 NavigablePath navigablePath,
 @Nonnull
 SqmToSqlAstConverter sqlAstConverter)

groupByClauseContains

@Internal
public boolean groupByClauseContains(@Nullable
 NavigablePath navigablePath,
 @Nonnull
 SqmToSqlAstConverter sqlAstConverter)

orderByClauseContains

@Internal
public boolean orderByClauseContains(@Nullable
 NavigablePath navigablePath,
 @Nonnull
 SqmToSqlAstConverter sqlAstConverter)

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class SqmQueryPart<T>

hashCode

public int hashCode()

Overrides:

hashCode in class SqmQueryPart<T>

isCompatible

public boolean isCompatible(@Nullable
 Object object)

Specified by:

isCompatible in interface SqmCacheable

Overrides:

isCompatible in class SqmQueryPart<T>

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

Overrides:

cacheHashCode in class SqmQueryPart<T>