Class SqmQuerySpec<T>

java.lang.Object

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

org.hibernate.query.sqm.tree.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)
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
void	applyPredicate(SqmPredicate predicate)
int	cacheHashCode()
boolean	containsCollectionFetches()
SqmQuerySpec<T>	copy(SqmCopyContext context)
boolean	equals(@Nullable Object object)
SqmQuerySpec<T>	getFirstQuerySpec()
SqmFromClause	getFromClause()	Obtains this container's SqmFromClause.
List<SqmExpression<?>>	getGroupByClauseExpressions()
List<SqmExpression<?>>	getGroupingExpressions()
@Nullable SqmPredicate	getGroupRestriction()
@Nullable SqmPredicate	getHavingClausePredicate()
SqmQuerySpec<T>	getLastQuerySpec()
@Nullable SqmPredicate	getRestriction()
List<SqmRoot<?>>	getRootList()
Set<SqmRoot<?>>	getRoots()
SqmSelectClause	getSelectClause()
JpaSelection<T>	getSelection()
@Nullable SqmWhereClause	getWhereClause()
boolean	groupByClauseContains(NavigablePath navigablePath, SqmToSqlAstConverter sqlAstConverter)
int	hashCode()
boolean	hasPositionalGroupItem()
boolean	isCompatible(Object object)
boolean	isDistinct()
boolean	isSimpleQueryPart()
boolean	orderByClauseContains(NavigablePath navigablePath, SqmToSqlAstConverter sqlAstConverter)
boolean	producesUniqueResults()
SqmQuerySpec<T>	setDistinct(boolean distinct)
SqmQuerySpec<T>	setFetch(@Nullable JpaExpression<? extends Number> fetch)
SqmQuerySpec<T>	setFetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)
void	setFromClause(SqmFromClause fromClause)
void	setGroupByClauseExpressions(List<SqmExpression<?>> groupByClauseExpressions)
SqmQuerySpec<T>	setGroupingExpressions(Expression<?>... groupExpressions)
SqmQuerySpec<T>	setGroupingExpressions(List<? extends Expression<?>> groupExpressions)
SqmQuerySpec<T>	setGroupRestriction(@Nullable Expression<Boolean> restriction)
SqmQuerySpec<T>	setGroupRestriction(Predicate @Nullable ... restrictions)
SqmQuerySpec<T>	setGroupRestriction(List<Predicate> restrictions)
SqmQuerySpec<T>	setGroupRestriction(@Nullable JpaPredicate restriction)
void	setHavingClausePredicate(@Nullable SqmPredicate havingClausePredicate)
SqmQuerySpec<T>	setOffset(@Nullable JpaExpression<? extends Number> offset)
SqmQuerySpec<T>	setRestriction(@Nullable Expression<Boolean> restriction)
SqmQuerySpec<T>	setRestriction(Predicate @Nullable ... restrictions)
SqmQuerySpec<T>	setRestriction(List<Predicate> restrictions)
SqmQuerySpec<T>	setRestriction(@Nullable JpaPredicate restriction)
void	setSelectClause(SqmSelectClause selectClause)
SqmQuerySpec<T>	setSelection(JpaSelection<T> selection)
SqmQuerySpec<T>	setSortSpecifications(List<? extends JpaOrder> sortSpecifications)
void	setWhereClause(@Nullable 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(NodeBuilder nodeBuilder)

SqmQuerySpec

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

Method Details

copy

public SqmQuerySpec<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

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

getFirstQuerySpec

public SqmQuerySpec<T> getFirstQuerySpec()

Specified by:

getFirstQuerySpec in class SqmQueryPart<T>

getLastQuerySpec

public SqmQuerySpec<T> getLastQuerySpec()

Specified by:

getLastQuerySpec in class SqmQueryPart<T>

isSimpleQueryPart

public boolean isSimpleQueryPart()

Specified by:

isSimpleQueryPart in class SqmQueryPart<T>

getFromClause

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(SqmFromClause fromClause)

producesUniqueResults

public boolean producesUniqueResults()

containsCollectionFetches

public boolean containsCollectionFetches()

getSelectClause

public SqmSelectClause getSelectClause()

setSelectClause

public void setSelectClause(SqmSelectClause selectClause)

getWhereClause

public @Nullable SqmWhereClause getWhereClause()

Specified by:

getWhereClause in interface SqmWhereClauseContainer

setWhereClause

public void setWhereClause(@Nullable SqmWhereClause whereClause)

applyPredicate

public void applyPredicate(SqmPredicate predicate)

Specified by:

applyPredicate in interface SqmWhereClauseContainer

hasPositionalGroupItem

public boolean hasPositionalGroupItem()

getGroupByClauseExpressions

public List<SqmExpression<?>> getGroupByClauseExpressions()

setGroupByClauseExpressions

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

getHavingClausePredicate

public @Nullable SqmPredicate getHavingClausePredicate()

setHavingClausePredicate

public void setHavingClausePredicate(@Nullable SqmPredicate havingClausePredicate)

isDistinct

public boolean isDistinct()

Specified by:

isDistinct in interface JpaQueryStructure<T>

setDistinct

public SqmQuerySpec<T> setDistinct(boolean distinct)

Specified by:

setDistinct in interface JpaQueryStructure<T>

getSelection

public JpaSelection<T> getSelection()

Specified by:

getSelection in interface JpaQueryStructure<T>

setSelection

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

Specified by:

setSelection in interface JpaQueryStructure<T>

getRoots

public Set<SqmRoot<?>> getRoots()

Specified by:

getRoots in interface JpaQueryStructure<T>

getRootList

public List<SqmRoot<?>> getRootList()

Specified by:

getRootList in interface JpaQueryStructure<T>

addRoot

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

Specified by:

addRoot in interface JpaQueryStructure<T>

getRestriction

public @Nullable SqmPredicate getRestriction()

Specified by:

getRestriction in interface JpaQueryStructure<T>

setRestriction

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

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

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

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

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

Specified by:

setRestriction in interface JpaQueryStructure<T>

setRestriction

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

Specified by:

setRestriction in interface JpaQueryStructure<T>

getGroupingExpressions

public List<SqmExpression<?>> getGroupingExpressions()

Specified by:

getGroupingExpressions in interface JpaQueryStructure<T>

setGroupingExpressions

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

Specified by:

setGroupingExpressions in interface JpaQueryStructure<T>

setGroupingExpressions

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

Specified by:

setGroupingExpressions in interface JpaQueryStructure<T>

getGroupRestriction

public @Nullable SqmPredicate getGroupRestriction()

Specified by:

getGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

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

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

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

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

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

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setGroupRestriction

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

Specified by:

setGroupRestriction in interface JpaQueryStructure<T>

setSortSpecifications

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

Specified by:

setSortSpecifications in interface JpaQueryPart<T>

Specified by:

setSortSpecifications in interface JpaQueryStructure<T>

Overrides:

setSortSpecifications in class SqmQueryPart<T>

setOffset

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

Specified by:

setOffset in interface JpaQueryPart<T>

Specified by:

setOffset in interface JpaQueryStructure<T>

Overrides:

setOffset in class SqmQueryPart<T>

setFetch

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

Specified by:

setFetch in interface JpaQueryPart<T>

Specified by:

setFetch in interface JpaQueryStructure<T>

Overrides:

setFetch in class SqmQueryPart<T>

setFetch

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

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(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmQueryPart<T>

whereClauseContains

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

groupByClauseContains

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

orderByClauseContains

@Internal
public boolean orderByClauseContains(NavigablePath navigablePath,
 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(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>