Package org.hibernate.query.sqm.tree.domain

Interface SqmPath<T>

All Superinterfaces:

Expression<T>, JpaCriteriaNode, JpaExpression<T>, JpaPath<T>, JpaSelection<T>, JpaTupleElement<T>, Path<T>, Selection<T>, SemanticPathPart, Serializable, SqmExpressibleAccessor<T>, SqmExpression<T>, SqmNode, SqmSelectableNode<T>, SqmTypedNode<T>, SqmVisitableNode, TupleElement<T>

All Known Subinterfaces:

DiscriminatorSqmPath<T>, SqmAttributeJoin<O,T>, SqmCorrelatedJoin<L,R>, SqmCorrelatedSingularValuedJoin<L,R>, SqmCorrelation<L,R>, SqmFrom<L,R>, SqmJoin<L,R>, SqmPathWrapper<W,T>, SqmSimplePath<T>, SqmSingularValuedJoin<L,R>, SqmTreatedAttributeJoin<L,R,R1>, SqmTreatedFrom<L,R,R1>, SqmTreatedJoin<L,R,R1>, SqmTreatedPath<T,S>

All Known Implementing Classes:

AbstractSqmAttributeJoin, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmPath, AbstractSqmPluralJoin, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, AnyDiscriminatorSqmPath, EmbeddedDiscriminatorSqmPath, EntityDiscriminatorSqmPath, NonAggregatedCompositeSimplePath, SqmAnyValuedSimplePath, SqmBagJoin, SqmBasicValuedSimplePath, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmCteRoot, SqmDerivedJoin, SqmDerivedRoot, SqmElementAggregateFunction, SqmEmbeddedValuedSimplePath, SqmEntityJoin, SqmEntityValuedSimplePath, SqmFkExpression, SqmFunctionJoin, SqmFunctionPath, SqmFunctionRoot, SqmIndexAggregateFunction, SqmIndexedCollectionAccessPath, SqmListJoin, SqmMapJoin, SqmPluralPartJoin, SqmPluralValuedSimplePath, SqmRoot, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEmbeddedValuedSimplePath, SqmTreatedEntityJoin, SqmTreatedEntityValuedSimplePath, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSimplePath, SqmTreatedSingularJoin

public interface SqmPath<T>
extends SqmExpression<T>, SemanticPathPart, JpaPath<T>

Models a reference to a part of the application's domain model as part of an SQM tree. This correlates roughly to the JPA Criteria notion of Path, hence the name.

Field Summary

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

log

Method Summary

Modifier and Type	Method	Description
default void	applyInferableType(@Nullable SqmExpressible<?> type)	Used to apply type information based on the expression's usage within the query.
SqmPath<T>	copy(SqmCopyContext context)
default SqmRoot<?>	findRoot()
<K, V, M extends Map<K, V>> SqmExpression<M>	get(MapAttribute<? super T,K,V> map)
<E, C extends Collection<E>> SqmExpression<C>	get(PluralAttribute<? super T,C,E> collection)
<Y> SqmPath<Y>	get(SingularAttribute<? super T,Y> attribute)
<Y> SqmPath<Y>	get(String attributeName)
default <Y> SqmPath<Y>	get(String attributeName, boolean includeSubtypes)	Same as get(String), but if includeSubtypes is set to true and this path is polymorphic, also try finding subtype attributes.
String	getExplicitAlias()	Retrieve the explicit alias, if one.
default JavaType<T>	getJavaTypeDescriptor()
SqmPath<?>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
NavigablePath	getNavigablePath()	Returns the NavigablePath.
SqmPathSource<T>	getNodeType()	This node's type is its "referenced path source"
SqmPathSource<?>	getReferencedPathSource()	The path source that this path refers to (and that most likely created it).
SqmPathSource<?>	getResolvedModel()	Get this path's actual resolved model, i.e.
SqmPath<?>	getReusablePath(String name)
List<SqmPath<?>>	getReusablePaths()	Returns an immutable List of reusable paths
void	registerReusablePath(SqmPath<?> path)	Register a reusable path relative to this path
default String	resolveAlias()	Retrieve the explicit alias, if one, otherwise return a generated one and set that as explicit alias.
default SqmPath<?>	resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)
SqmPath<?>	resolvePathPart(String name, boolean isTerminal, SqmCreationState creationState)
void	setExplicitAlias(String explicitAlias)	Set the explicit alias for this path
<S extends T> SqmTreatedPath<T,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedPath<T,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends T> SqmTreatedPath<T,S>	treatAs(Class<S> treatJavaType, String alias, boolean fetch)
<S extends T> SqmTreatedPath<T,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedPath<T,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
<S extends T> SqmTreatedPath<T,S>	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)
SqmExpression<Class<? extends T>>	type()
void	visitReusablePaths(Consumer<SqmPath<?>> consumer)	Visit each reusable path relative to this path

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.Path

getModel

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.SqmNode

asLoggableText, nodeBuilder

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

accept, appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Method Details

getNavigablePath

NavigablePath getNavigablePath()

Returns the NavigablePath.

Specified by:

getNavigablePath in interface JpaPath<T>

getReferencedPathSource

SqmPathSource<?> getReferencedPathSource()

The path source that this path refers to (and that most likely created it).

See Also:

• SqmPathSource.createSqmPath(org.hibernate.query.sqm.tree.domain.SqmPath<?>, org.hibernate.query.sqm.SqmPathSource<?>)

getExplicitAlias

String getExplicitAlias()

Retrieve the explicit alias, if one. May return null

setExplicitAlias

void setExplicitAlias(String explicitAlias)

Set the explicit alias for this path

resolveAlias

default String resolveAlias()

Retrieve the explicit alias, if one, otherwise return a generated one and set that as explicit alias.

getLhs

SqmPath<?> getLhs()

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<T>

getReusablePaths

List<SqmPath<?>> getReusablePaths()

Returns an immutable List of reusable paths

visitReusablePaths

void visitReusablePaths(Consumer<SqmPath<?>> consumer)

Visit each reusable path relative to this path

registerReusablePath

void registerReusablePath(SqmPath<?> path)

Register a reusable path relative to this path

getReusablePath

SqmPath<?> getReusablePath(String name)

getNodeType

SqmPathSource<T> getNodeType()

This node's type is its "referenced path source"

Specified by:

getNodeType in interface SqmExpression<T>

Specified by:

getNodeType in interface SqmTypedNode<T>

applyInferableType

default void applyInferableType(@Nullable SqmExpressible<?> type)

Description copied from interface: SqmExpression

Used to apply type information based on the expression's usage within the query.

Specified by:

applyInferableType in interface SqmExpression<T>

getJavaTypeDescriptor

default JavaType<T> getJavaTypeDescriptor()

Specified by:

getJavaTypeDescriptor in interface JpaTupleElement<T>

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(Class<S> treatJavaType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaPath<T>

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(EntityDomainType<S> treatTarget)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaPath<T>

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(Class<S> treatJavaType,
 String alias)

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(EntityDomainType<S> treatTarget,
 String alias)

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(Class<S> treatJavaType,
 String alias,
 boolean fetch)

treatAs

<S extends T> SqmTreatedPath<T,S> treatAs(EntityDomainType<S> treatTarget,
 String alias,
 boolean fetch)

findRoot

default SqmRoot<?> findRoot()

resolvePathPart

SqmPath<?> resolvePathPart(String name,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolvePathPart in interface SemanticPathPart

resolveIndexedAccess

default SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolveIndexedAccess in interface SemanticPathPart

getResolvedModel

SqmPathSource<?> getResolvedModel()

Get this path's actual resolved model, i.e. the concrete type for generic attributes.

get

<Y> SqmPath<Y> get(SingularAttribute<? super T,Y> attribute)

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

get

<E,
C extends Collection<E>> SqmExpression<C> get(PluralAttribute<? super T,C,E> collection)

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

get

<K,
V,
M extends Map<K,
V>> SqmExpression<M> get(MapAttribute<? super T,K,V> map)

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

type

SqmExpression<Class<? extends T>> type()

Specified by:

type in interface JpaPath<T>

Specified by:

type in interface Path<T>

get

<Y> SqmPath<Y> get(String attributeName)

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

get

default <Y> SqmPath<Y> get(String attributeName,
 boolean includeSubtypes)

Same as get(String), but if includeSubtypes is set to true and this path is polymorphic, also try finding subtype attributes.

See Also:

• SqmPathSource.findSubPathSource(String, boolean)

copy

SqmPath<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>