Top Description Fields Constructors Methods
org.hibernate.query.sqm.tree.select

public Class SqmQuerySpec<T>

extends SqmQueryPart<T>
implements SqmNode, SqmFromClauseContainer, SqmWhereClauseContainer, JpaQueryStructure<T>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.criteria.JpaQueryStructure, org.hibernate.query.criteria.JpaQueryPart, org.hibernate.query.criteria.JpaCriteriaNode, java.io.Serializable, org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer, org.hibernate.query.sqm.tree.from.SqmFromClauseContainer, org.hibernate.query.sqm.tree.SqmNode
Imports
java.util.ArrayList, .Collections, .HashSet, .List, .Set, org.hibernate.internal.util.collections.CollectionHelper, org.hibernate.metamodel.mapping.CollectionPart, org.hibernate.metamodel.model.domain.EmbeddableDomainType, org.hibernate.query.SemanticException, org.hibernate.query.criteria.JpaExpression, .JpaOrder, .JpaPredicate, .JpaQueryStructure, .JpaRoot, .JpaSelection, org.hibernate.query.sqm.FetchClauseType, .NodeBuilder, .SemanticQueryWalker, org.hibernate.query.sqm.tree.SqmCopyContext, .SqmNode, org.hibernate.query.sqm.tree.domain.SqmEmbeddedValuedSimplePath, .SqmEntityValuedSimplePath, .SqmPath, .SqmTreatedPath, org.hibernate.query.sqm.tree.expression.SqmAliasedNodeRef, .SqmExpression, org.hibernate.query.sqm.tree.from.SqmAttributeJoin, .SqmCrossJoin, .SqmEntityJoin, .SqmFrom, .SqmFromClause, .SqmFromClauseContainer, .SqmJoin, .SqmRoot, org.hibernate.query.sqm.tree.predicate.SqmPredicate, .SqmWhereClause, .SqmWhereClauseContainer, org.hibernate.spi.NavigablePath, jakarta.persistence.criteria.Expression, .Predicate, jakarta.persistence.metamodel.SingularAttribute
Defines the commonality between a root query and a subquery.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private SqmFromClause
fromClause

private List<SqmExpression<?>>
groupByClauseExpressions

private boolean
hasPositionalGroupItem

private SqmPredicate
havingClausePredicate

private SqmSelectClause
selectClause

private SqmWhereClause
whereClause

Constructor Summary

AccessConstructor and Description
public
SqmQuerySpec(NodeBuilder nodeBuilder)

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

Method Summary

Modifier and TypeMethod and Description
public <X> X
accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation
public SqmQuerySpec<T>
addRoot(JpaRoot<?> root)

Implements org.hibernate.query.criteria.JpaQueryStructure.addRoot.

public void
appendHqlString(StringBuilder sb)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.appendHqlString.

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

private void
appendJoins(SqmFrom<?, ?> sqmFrom, StringBuilder sb)

private void
appendJoins(SqmFrom<?, ?> sqmFrom, String correlationPrefix, StringBuilder sb)

private void
appendTreatJoins(SqmFrom<?, ?> sqmFrom, StringBuilder sb)

public void
applyPredicate(SqmPredicate predicate)

Implements org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer.applyPredicate.

private void
assertEmbeddableCollections(NavigablePath navigablePath, EmbeddableDomainType<?> embeddableType)

private void
assertFetchOwner(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> owner, SqmJoin<?, ?> fetchJoin)

private void
collectSelectedFromSet(Set<SqmFrom<?, ?>> selectedFromSet, SqmSelectableNode<?> selectableNode)

private void
collectSelectedFromSet(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> sqmFrom)

public boolean
containsCollectionFetches()

public SqmQuerySpec<T>
copy(SqmCopyContext context)

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.copy.

Implements org.hibernate.query.sqm.tree.SqmNode.copy.

public SqmQuerySpec<T>
getFirstQuerySpec()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.getFirstQuerySpec.

public SqmFromClause
getFromClause()

Implements org.hibernate.query.sqm.tree.from.SqmFromClauseContainer.getFromClause.

Obtains this container's SqmFromClause.
public List<SqmExpression<?>>
getGroupByClauseExpressions()

public List<SqmExpression<?>>
getGroupingExpressions()

Implements org.hibernate.query.criteria.JpaQueryStructure.getGroupingExpressions.

public SqmPredicate
getGroupRestriction()

Implements org.hibernate.query.criteria.JpaQueryStructure.getGroupRestriction.

public SqmPredicate
getHavingClausePredicate()

public SqmQuerySpec<T>
getLastQuerySpec()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.getLastQuerySpec.

public SqmPredicate
getRestriction()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRestriction.

public List<SqmRoot<?>>
getRootList()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRootList.

public Set<SqmRoot<?>>
getRoots()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRoots.

public SqmSelectClause
getSelectClause()

public JpaSelection<T>
getSelection()

Implements org.hibernate.query.criteria.JpaQueryStructure.getSelection.

public SqmWhereClause
getWhereClause()

Implements org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer.getWhereClause.

public boolean
groupByClauseContains(NavigablePath path)

public boolean
hasPositionalGroupItem()

public boolean
isDistinct()

Implements org.hibernate.query.criteria.JpaQueryStructure.isDistinct.

public boolean
isSimpleQueryPart()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.isSimpleQueryPart.

public boolean
producesUniqueResults()

public SqmQuerySpec<T>
setDistinct(boolean distinct)

Implements org.hibernate.query.criteria.JpaQueryStructure.setDistinct.

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

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setFetch.

Implements org.hibernate.query.criteria.JpaQueryStructure.setFetch, org.hibernate.query.criteria.JpaQueryPart.setFetch.

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

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setFetch.

Implements org.hibernate.query.criteria.JpaQueryStructure.setFetch, org.hibernate.query.criteria.JpaQueryPart.setFetch.

public void
setFromClause(SqmFromClause fromClause)

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

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupingExpressions.

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupingExpressions.

public SqmQuerySpec<T>
setGroupRestriction(JpaPredicate restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

public void
setHavingClausePredicate(SqmPredicate havingClausePredicate)

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

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setOffset.

Implements org.hibernate.query.criteria.JpaQueryStructure.setOffset, org.hibernate.query.criteria.JpaQueryPart.setOffset.

public SqmQuerySpec<T>
setRestriction(JpaPredicate restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

public void
setSelectClause(SqmSelectClause selectClause)

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

Implements org.hibernate.query.criteria.JpaQueryStructure.setSelection.

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

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setSortSpecifications.

Implements org.hibernate.query.criteria.JpaQueryStructure.setSortSpecifications, org.hibernate.query.criteria.JpaQueryPart.setSortSpecifications.

public void
setWhereClause(SqmWhereClause whereClause)

public void
validateFetchOwners()

private void
validateFetchOwners(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> owner, SqmFrom<?, ?> joinContainer)

public void
validateQueryStructureAndFetchOwners()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.validateQueryStructureAndFetchOwners.

Inherited from org.hibernate.query.sqm.tree.select.SqmQueryPart:
copyTogetFetchgetFetchClauseTypegetFetchExpressiongetOffsetgetOffsetExpressiongetOrderByClausegetSortSpecificationsnodeBuildersetFetchExpressionsetFetchExpressionsetOffsetExpressionsetOrderByClause

Field Detail

fromClauseback to summary
private SqmFromClause fromClause
groupByClauseExpressionsback to summary
private List<SqmExpression<?>> groupByClauseExpressions
hasPositionalGroupItemback to summary
private boolean hasPositionalGroupItem
havingClausePredicateback to summary
private SqmPredicate havingClausePredicate
selectClauseback to summary
private SqmSelectClause selectClause
whereClauseback to summary
private SqmWhereClause whereClause

Constructor Detail

SqmQuerySpecback to summary
public SqmQuerySpec(NodeBuilder nodeBuilder)
SqmQuerySpecback to summary
public SqmQuerySpec(SqmQuerySpec<T> original, SqmCopyContext context)

Method Detail

acceptback to summary
public <X> X accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation

Annotations
@Override
addRootback to summary
public SqmQuerySpec<T> addRoot(JpaRoot<?> root)

Implements org.hibernate.query.criteria.JpaQueryStructure.addRoot.

Annotations
@Override
appendHqlStringback to summary
public void appendHqlString(StringBuilder sb)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.appendHqlString.

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

Annotations
@Override
appendJoinsback to summary
private void appendJoins(SqmFrom<?, ?> sqmFrom, StringBuilder sb)
appendJoinsback to summary
private void appendJoins(SqmFrom<?, ?> sqmFrom, String correlationPrefix, StringBuilder sb)
appendTreatJoinsback to summary
private void appendTreatJoins(SqmFrom<?, ?> sqmFrom, StringBuilder sb)
applyPredicateback to summary
public void applyPredicate(SqmPredicate predicate)

Implements org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer.applyPredicate.

Annotations
@Override
assertEmbeddableCollectionsback to summary
private void assertEmbeddableCollections(NavigablePath navigablePath, EmbeddableDomainType<?> embeddableType)
assertFetchOwnerback to summary
private void assertFetchOwner(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> owner, SqmJoin<?, ?> fetchJoin)
collectSelectedFromSetback to summary
private void collectSelectedFromSet(Set<SqmFrom<?, ?>> selectedFromSet, SqmSelectableNode<?> selectableNode)
collectSelectedFromSetback to summary
private void collectSelectedFromSet(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> sqmFrom)
containsCollectionFetchesback to summary
public boolean containsCollectionFetches()
copyback to summary
public SqmQuerySpec<T> copy(SqmCopyContext context)

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.copy.

Implements org.hibernate.query.sqm.tree.SqmNode.copy.

Annotations
@Override
getFirstQuerySpecback to summary
public SqmQuerySpec<T> getFirstQuerySpec()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.getFirstQuerySpec.

Annotations
@Override
getFromClauseback to summary
public SqmFromClause getFromClause()

Implements org.hibernate.query.sqm.tree.from.SqmFromClauseContainer.getFromClause.

Doc from org.hibernate.query.sqm.tree.from.SqmFromClauseContainer.getFromClause.

Obtains this container's SqmFromClause.

Returns:SqmFromClause

This container's SqmFromClause.

Annotations
@Override
getGroupByClauseExpressionsback to summary
public List<SqmExpression<?>> getGroupByClauseExpressions()
getGroupingExpressionsback to summary
public List<SqmExpression<?>> getGroupingExpressions()

Implements org.hibernate.query.criteria.JpaQueryStructure.getGroupingExpressions.

Annotations
@Override
getGroupRestrictionback to summary
public SqmPredicate getGroupRestriction()

Implements org.hibernate.query.criteria.JpaQueryStructure.getGroupRestriction.

Annotations
@Override
getHavingClausePredicateback to summary
public SqmPredicate getHavingClausePredicate()
getLastQuerySpecback to summary
public SqmQuerySpec<T> getLastQuerySpec()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.getLastQuerySpec.

Annotations
@Override
getRestrictionback to summary
public SqmPredicate getRestriction()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRestriction.

Annotations
@Override
getRootListback to summary
public List<SqmRoot<?>> getRootList()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRootList.

Annotations
@Override
getRootsback to summary
public Set<SqmRoot<?>> getRoots()

Implements org.hibernate.query.criteria.JpaQueryStructure.getRoots.

Annotations
@Override
getSelectClauseback to summary
public SqmSelectClause getSelectClause()
getSelectionback to summary
public JpaSelection<T> getSelection()

Implements org.hibernate.query.criteria.JpaQueryStructure.getSelection.

Annotations
@Override
@SuppressWarnings:unchecked
getWhereClauseback to summary
public SqmWhereClause getWhereClause()

Implements org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer.getWhereClause.

Annotations
@Override
groupByClauseContainsback to summary
public boolean groupByClauseContains(NavigablePath path)
hasPositionalGroupItemback to summary
public boolean hasPositionalGroupItem()
isDistinctback to summary
public boolean isDistinct()

Implements org.hibernate.query.criteria.JpaQueryStructure.isDistinct.

Annotations
@Override
isSimpleQueryPartback to summary
public boolean isSimpleQueryPart()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.isSimpleQueryPart.

Annotations
@Override
producesUniqueResultsback to summary
public boolean producesUniqueResults()
setDistinctback to summary
public SqmQuerySpec<T> setDistinct(boolean distinct)

Implements org.hibernate.query.criteria.JpaQueryStructure.setDistinct.

Annotations
@Override
setFetchback to summary
public SqmQuerySpec<T> setFetch(JpaExpression<? extends Number> fetch)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setFetch.

Implements org.hibernate.query.criteria.JpaQueryStructure.setFetch, org.hibernate.query.criteria.JpaQueryPart.setFetch.

Annotations
@Override
setFetchback to summary
public SqmQuerySpec<T> setFetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setFetch.

Implements org.hibernate.query.criteria.JpaQueryStructure.setFetch, org.hibernate.query.criteria.JpaQueryPart.setFetch.

Annotations
@Override
setFromClauseback to summary
public void setFromClause(SqmFromClause fromClause)
setGroupByClauseExpressionsback to summary
public void setGroupByClauseExpressions(List<SqmExpression<?>> groupByClauseExpressions)
setGroupingExpressionsback to summary
public SqmQuerySpec<T> setGroupingExpressions(List<? extends JpaExpression<?>> groupExpressions)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupingExpressions.

Annotations
@Override
setGroupingExpressionsback to summary
public SqmQuerySpec<T> setGroupingExpressions(JpaExpression<?>... groupExpressions)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupingExpressions.

Annotations
@Override
setGroupRestrictionback to summary
public SqmQuerySpec<T> setGroupRestriction(JpaPredicate restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

Annotations
@Override
setGroupRestrictionback to summary
public SqmQuerySpec<T> setGroupRestriction(Expression<Boolean> restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

Annotations
@Override
setGroupRestrictionback to summary
public SqmQuerySpec<T> setGroupRestriction(Predicate... restrictions)

Implements org.hibernate.query.criteria.JpaQueryStructure.setGroupRestriction.

Annotations
@Override
setHavingClausePredicateback to summary
public void setHavingClausePredicate(SqmPredicate havingClausePredicate)
setOffsetback to summary
public SqmQuerySpec<T> setOffset(JpaExpression<? extends Number> offset)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setOffset.

Implements org.hibernate.query.criteria.JpaQueryStructure.setOffset, org.hibernate.query.criteria.JpaQueryPart.setOffset.

Annotations
@Override
setRestrictionback to summary
public SqmQuerySpec<T> setRestriction(JpaPredicate restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

Annotations
@Override
setRestrictionback to summary
public SqmQuerySpec<T> setRestriction(Expression<Boolean> restriction)

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

Annotations
@Override
setRestrictionback to summary
public SqmQuerySpec<T> setRestriction(Predicate... restrictions)

Implements org.hibernate.query.criteria.JpaQueryStructure.setRestriction.

Annotations
@Override
setSelectClauseback to summary
public void setSelectClause(SqmSelectClause selectClause)
setSelectionback to summary
public SqmQuerySpec<T> setSelection(JpaSelection<T> selection)

Implements org.hibernate.query.criteria.JpaQueryStructure.setSelection.

Annotations
@Override
setSortSpecificationsback to summary
public SqmQuerySpec<T> setSortSpecifications(List<? extends JpaOrder> sortSpecifications)

Overrides org.hibernate.query.sqm.tree.select.SqmQueryPart.setSortSpecifications.

Implements org.hibernate.query.criteria.JpaQueryStructure.setSortSpecifications, org.hibernate.query.criteria.JpaQueryPart.setSortSpecifications.

Annotations
@Override
setWhereClauseback to summary
public void setWhereClause(SqmWhereClause whereClause)
validateFetchOwnersback to summary
public void validateFetchOwners()
validateFetchOwnersback to summary
private void validateFetchOwners(Set<SqmFrom<?, ?>> selectedFromSet, SqmFrom<?, ?> owner, SqmFrom<?, ?> joinContainer)
validateQueryStructureAndFetchOwnersback to summary
public void validateQueryStructureAndFetchOwners()

Implements abstract org.hibernate.query.sqm.tree.select.SqmQueryPart.validateQueryStructureAndFetchOwners.

Annotations
@Override