Package org.hibernate.query.sqm.tree.from

Class SqmRoot<E>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement<E>

org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection<E>

org.hibernate.query.sqm.tree.expression.AbstractSqmExpression<E>

org.hibernate.query.sqm.tree.domain.AbstractSqmPath<E>

org.hibernate.query.sqm.tree.domain.AbstractSqmFrom<E,E>

org.hibernate.query.sqm.tree.from.SqmRoot<E>

All Implemented Interfaces:

Expression<E>, FetchParent<E,E>, From<E,E>, Path<E>, Root<E>, Selection<E>, TupleElement<E>, Serializable, JpaCriteriaNode, JpaExpression<E>, JpaFetchParent<E,E>, JpaFrom<E,E>, JpaPath<E>, JpaRoot<E>, JpaSelection<E>, JpaTupleElement<E>, SemanticPathPart, SqmPath<E>, SqmExpression<E>, SqmFrom<E,E>, SqmSelectableNode<E>, SqmExpressibleAccessor<E>, SqmNode, SqmTypedNode<E>, SqmVisitableNode

Direct Known Subclasses:

SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCteRoot, SqmDerivedRoot, SqmFunctionRoot, SqmTreatedRoot

public class SqmRoot<E>
extends AbstractSqmFrom<E,E>
implements JpaRoot<E>

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqmRoot(EntityDomainType<E> entityType, String alias, boolean allowJoins, NodeBuilder nodeBuilder)
	SqmRoot(NavigablePath navigablePath, EntityDomainType<E> entityType, String alias, NodeBuilder nodeBuilder)
protected	SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, String alias, boolean allowJoins, NodeBuilder nodeBuilder)
protected	SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	addOrderedJoin(SqmJoin<?,?> join)
void	addSqmJoin(SqmJoin<E,?> join)	Add an associated join
boolean	containsOnlyInnerJoins()
SqmRoot<E>	copy(SqmCopyContext context)
void	copyTo(SqmRoot<E> target, SqmCopyContext context)
SqmCorrelatedRoot<E>	createCorrelation()
SqmRoot<?>	findRoot()
String	getEntityName()
SqmPath<?>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
EntityDomainType<E>	getManagedType()
SqmEntityDomainType<E>	getModel()
List<SqmJoin<?,?>>	getOrderedJoins()
boolean	isAllowJoins()
String	toString()
<S extends E> SqmTreatedFrom<E,E,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends E> SqmTreatedRoot	treatAs(Class<S> treatJavaType, String alias)
<S extends E> SqmTreatedRoot	treatAs(Class<S> treatJavaType, String alias, boolean fetch)
<S extends E> SqmTreatedFrom<E,E,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends E> SqmTreatedRoot	treatAs(EntityDomainType<S> treatTarget, String alias)
<S extends E> SqmTreatedRoot	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmFrom

addTreat, alias, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getNumberOfJoins, getParentPath, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, id, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinCollection, joinCollection, joinLateral, joinLateral, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, removeLeftFetchJoins, resolvePathPart, setExplicitAlias, visitSqmJoins

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmPath

copyTo, equals, get, get, get, get, get, getExpressible, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, hashCode, registerReusablePath, resolvePath, resolvePath, type, visitReusablePaths

Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression

applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

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

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

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

crossJoin, crossJoin, id, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinLateral, joinLateral, joinLateral, joinLateral, joinLateral

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

getParentPath

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

alias, getCompoundSelectionItems, getSelectionItems

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

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, castAs, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo, visitSubSelectableNodes

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

getReferencedPathSource, hasTreats, resolveAlias

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

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.domain.SqmPath

applyInferableType, get, get, get, get, get, getJavaTypeDescriptor, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, type, visitReusablePaths

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode

getTupleLength

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

getExpressible, getNodeJavaType

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

toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

SqmRoot

public SqmRoot(EntityDomainType<E> entityType,
 String alias,
 boolean allowJoins,
 NodeBuilder nodeBuilder)

SqmRoot

protected SqmRoot(NavigablePath navigablePath,
 SqmPathSource<E> referencedNavigable,
 NodeBuilder nodeBuilder)

SqmRoot

public SqmRoot(NavigablePath navigablePath,
 EntityDomainType<E> entityType,
 String alias,
 NodeBuilder nodeBuilder)

SqmRoot

protected SqmRoot(NavigablePath navigablePath,
 SqmPathSource<E> referencedNavigable,
 String alias,
 boolean allowJoins,
 NodeBuilder nodeBuilder)

Method Details

copy

public SqmRoot<E> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<E>

Specified by:

copy in interface SqmFrom<E,E>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<E>

Specified by:

copy in interface SqmSelectableNode<E>

Specified by:

copy in interface SqmTypedNode<E>

copyTo

@Internal
public void copyTo(SqmRoot<E> target,
 SqmCopyContext context)

getLhs

public SqmPath<?> getLhs()

Description copied from interface: SqmPath

Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join

Specified by:

getLhs in interface JpaPath<E>

Specified by:

getLhs in interface SqmPath<E>

Overrides:

getLhs in class AbstractSqmPath<E>

isAllowJoins

public boolean isAllowJoins()

getOrderedJoins

public List<SqmJoin<?,?>> getOrderedJoins()

addOrderedJoin

public void addOrderedJoin(SqmJoin<?,?> join)

addSqmJoin

public void addSqmJoin(SqmJoin<E,?> join)

Description copied from interface: SqmFrom

Add an associated join

Specified by:

addSqmJoin in interface SqmFrom<E,E>

Overrides:

addSqmJoin in class AbstractSqmFrom<E,E>

findRoot

public SqmRoot<?> findRoot()

Specified by:

findRoot in interface SqmPath<E>

getEntityName

public String getEntityName()

toString

public String toString()

Overrides:

toString in class AbstractSqmPath<E>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

getModel

public SqmEntityDomainType<E> getModel()

Specified by:

getModel in interface JpaRoot<E>

Specified by:

getModel in interface Path<E>

Specified by:

getModel in interface Root<E>

Overrides:

getModel in class AbstractSqmPath<E>

getManagedType

public EntityDomainType<E> getManagedType()

Specified by:

getManagedType in interface JpaRoot<E>

createCorrelation

public SqmCorrelatedRoot<E> createCorrelation()

Specified by:

createCorrelation in class AbstractSqmFrom<E,E>

containsOnlyInnerJoins

public boolean containsOnlyInnerJoins()

treatAs

public <S extends E> SqmTreatedFrom<E,E,S> treatAs(Class<S> treatJavaType)
                                            throws PathException

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaFrom<E,E>

Specified by:

treatAs in interface JpaPath<E>

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>

Throws:

PathException

treatAs

public <S extends E> SqmTreatedFrom<E,E,S> treatAs(EntityDomainType<S> treatTarget)
                                            throws PathException

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaFrom<E,E>

Specified by:

treatAs in interface JpaPath<E>

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>

Throws:

PathException

treatAs

public <S extends E> SqmTreatedRoot treatAs(Class<S> treatJavaType,
 String alias)

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(EntityDomainType<S> treatTarget,
 String alias)

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(Class<S> treatJavaType,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(EntityDomainType<S> treatTarget,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class AbstractSqmFrom<E,E>