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

Class AbstractSqmPath<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSqmFrom, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, AnyDiscriminatorSqmPath, EmbeddedDiscriminatorSqmPath, EntityDiscriminatorSqmPath, SqmFkExpression, SqmFunctionPath, SqmIndexedCollectionAccessPath

public abstract class AbstractSqmPath<T>
extends AbstractSqmExpression<T>
implements SqmPath<T>

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSqmPath(NavigablePath navigablePath, SqmPathSource<T> referencedPathSource, SqmPath<?> lhs, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
protected void	copyTo(AbstractSqmPath<T> target, SqmCopyContext context)
<K, V, M extends Map<K, V>> SqmExpression<M>	get(MapAttribute<? super T,K,V> attribute)
<E, C extends Collection<E>> SqmExpression<C>	get(PluralAttribute<? super T,C,E> attribute)
<Y> SqmPath<Y>	get(SingularAttribute<? super T,Y> jpaAttribute)
<Y> SqmPath<Y>	get(String attributeName)
<Y> SqmPath<Y>	get(String attributeName, boolean includeSubtypes)	Same as SqmPath.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.
SqmExpressible<T>	getExpressible()
SqmPath<?>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
SqmPathSource<T>	getModel()
NavigablePath	getNavigablePath()	Returns the NavigablePath.
protected NavigablePath	getNavigablePathCopy(SqmPath<?> parent)	Utility that checks if this path's parent navigable path is compatible with the specified SQM parent, and if not creates a copy of the navigable path with the correct parent.
SqmPathSource<T>	getNodeType()	This node's type is its "referenced path source"
SqmPathSource<T>	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
protected <S extends T> SqmTreatedPath<T,S>	getTreatedPath(ManagedDomainType<S> treatTarget)
void	registerReusablePath(SqmPath<?> path)	Register a reusable path relative to this path
protected <X> SqmPath<X>	resolvePath(String attributeName, SqmPathSource<X> pathSource)
protected <X> SqmPath<X>	resolvePath(PersistentAttribute<?,X> attribute)
void	setExplicitAlias(String explicitAlias)	Set the explicit alias for this path
String	toString()
<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 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

alias, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

asLoggableText, nodeBuilder

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

applyInferableType, copy, findRoot, getJavaTypeDescriptor, resolveAlias, resolveIndexedAccess, resolvePathPart

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

getTupleLength

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

getNodeJavaType

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

accept, appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

AbstractSqmPath

protected AbstractSqmPath(NavigablePath navigablePath,
 SqmPathSource<T> referencedPathSource,
 SqmPath<?> lhs,
 NodeBuilder nodeBuilder)

Method Details

copyTo

protected void copyTo(AbstractSqmPath<T> target,
 SqmCopyContext context)

getNodeType

public SqmPathSource<T> getNodeType()

Description copied from interface: SqmPath

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

Specified by:

getNodeType in interface SqmExpression<T>

Specified by:

getNodeType in interface SqmPath<T>

Specified by:

getNodeType in interface SqmTypedNode<T>

Overrides:

getNodeType in class AbstractJpaTupleElement<T>

getReferencedPathSource

public SqmPathSource<T> getReferencedPathSource()

Description copied from interface: SqmPath

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

Specified by:

getReferencedPathSource in interface SqmPath<T>

See Also:

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

getNavigablePath

public NavigablePath getNavigablePath()

Description copied from interface: SqmPath

Returns the NavigablePath.

Specified by:

getNavigablePath in interface JpaPath<T>

Specified by:

getNavigablePath in interface SqmPath<T>

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

Specified by:

getLhs in interface SqmPath<T>

getReusablePaths

public List<SqmPath<?>> getReusablePaths()

Description copied from interface: SqmPath

Returns an immutable List of reusable paths

Specified by:

getReusablePaths in interface SqmPath<T>

visitReusablePaths

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

Description copied from interface: SqmPath

Visit each reusable path relative to this path

Specified by:

visitReusablePaths in interface SqmPath<T>

registerReusablePath

public void registerReusablePath(SqmPath<?> path)

Description copied from interface: SqmPath

Register a reusable path relative to this path

Specified by:

registerReusablePath in interface SqmPath<T>

getReusablePath

public SqmPath<?> getReusablePath(String name)

Specified by:

getReusablePath in interface SqmPath<T>

getExplicitAlias

public String getExplicitAlias()

Description copied from interface: SqmPath

Retrieve the explicit alias, if one. May return null

Specified by:

getExplicitAlias in interface SqmPath<T>

setExplicitAlias

public void setExplicitAlias(String explicitAlias)

Description copied from interface: SqmPath

Set the explicit alias for this path

Specified by:

setExplicitAlias in interface SqmPath<T>

getModel

public SqmPathSource<T> getModel()

Specified by:

getModel in interface Path<T>

getResolvedModel

public SqmPathSource<?> getResolvedModel()

Description copied from interface: SqmPath

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

Specified by:

getResolvedModel in interface SqmPath<T>

getExpressible

public SqmExpressible<T> getExpressible()

Specified by:

getExpressible in interface SqmExpressibleAccessor<T>

Specified by:

getExpressible in interface SqmTypedNode<T>

type

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

Specified by:

type in interface JpaPath<T>

Specified by:

type in interface Path<T>

Specified by:

type in interface SqmPath<T>

get

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

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

Specified by:

get in interface SqmPath<T>

get

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

Description copied from interface: SqmPath

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

Specified by:

get in interface SqmPath<T>

See Also:

• SqmPathSource.findSubPathSource(String, boolean)

resolvePath

protected <X> SqmPath<X> resolvePath(PersistentAttribute<?,X> attribute)

resolvePath

protected <X> SqmPath<X> resolvePath(String attributeName,
 SqmPathSource<X> pathSource)

getTreatedPath

protected <S extends T> SqmTreatedPath<T,S> getTreatedPath(ManagedDomainType<S> treatTarget)

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

getNavigablePathCopy

protected NavigablePath getNavigablePathCopy(SqmPath<?> parent)

Utility that checks if this path's parent navigable path is compatible with the specified SQM parent, and if not creates a copy of the navigable path with the correct parent.

get

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

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

Specified by:

get in interface SqmPath<T>

get

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

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

Specified by:

get in interface SqmPath<T>

get

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

Specified by:

get in interface JpaPath<T>

Specified by:

get in interface Path<T>

Specified by:

get in interface SqmPath<T>

toString

public String toString()

Overrides:

toString in class Object