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>, SqmCacheable, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

Direct Known Subclasses:

AbstractSqmFrom, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, SqmFkExpression, SqmFunctionPath, SqmIndexedCollectionAccessPath

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

See Also:

• Serialized Form

Field Summary

Fields inherited from interface 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
int	cacheHashCode()
protected void	copyTo(AbstractSqmPath<T> target, SqmCopyContext context)
boolean	equals(Object object)
SqmBooleanPath	get(BooleanAttribute<? super T> attribute)
<C extends Comparable<? super C>> ComparableExpression<C>	get(ComparableAttribute<? super T, C> attribute)
<K, V, M extends Map<K,V>> SqmPluralPath<M,V>	get(MapAttribute<? super T, K, V> attribute)
<N extends Number & Comparable<N>> SqmNumericPath<N>	get(NumericAttribute<? super T, N> attribute)
<E, C extends Collection<E>> SqmPluralPath<C,E>	get(PluralAttribute<? super T, C, E> attribute)
<Y> SqmPath<Y>	get(SingularAttribute<? super T, Y> jpaAttribute)
<T1 extends Temporal & Comparable<? super T1>> TemporalExpression<T1>	get(TemporalAttribute<? super T, T1> attribute)
SqmTextPath	get(TextAttribute<? super T> attribute)
<Y> SqmPath<Y>	get(String attributeName)
SqmPath<?>	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.
SqmBindableType<T>	getExpressible()
JavaType<T>	getJavaTypeDescriptor()
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.
JavaType<T>	getNodeJavaType()	The Java type descriptor for this node.
SqmBindableType<T>	getNodeType()	The expression's type.
SqmPathSource<T>	getReferencedPathSource()	The path source that this path refers to (and that most likely created it).
SqmPathSource<T>	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)
int	hashCode()
boolean	isCompatible(Object object)
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 AbstractSqmExpression

applyInferableType, as, cast, coalesce, coalesce, count, countDistinct, equalTo, equalTo, in, in, in, in, in, internalApplyInferableType, isMember, isNotMember, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo, nullif, nullif, selectCase, selectCase

Methods inherited from class AbstractJpaSelection

alias, getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class Object

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

Methods inherited from interface JpaExpression

coalesce, coalesce, count, countDistinct, in, isMember, isNotMember, nullif, nullif, selectCase, selectCase

Methods inherited from interface JpaPath

getParentPath, treat

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface 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 SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmPath

applyInferableType, copy, findRoot, resolveIndexedAccess, resolvePathPart

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmVisitableNode

accept, appendHqlString, toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

AbstractSqmPath

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

Method Details

copyTo

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

getNodeType

@Nonnull
public SqmBindableType<T> getNodeType()

Description copied from interface: SqmExpression

The expression's type.

Can change as a result of calls to SqmExpression.applyInferableType(SqmBindableType)

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(SqmPath, 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

@Nullable
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

@Nullable
public SqmPath<?> getReusablePath(String name)

Specified by:

getReusablePath in interface SqmPath<T>

getExplicitAlias

@Nullable
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(@Nullable
 String explicitAlias)

Description copied from interface: SqmPath

Set the explicit alias for this path

Specified by:

setExplicitAlias in interface SqmPath<T>

getModel

@Nonnull
public SqmPathSource<T> getModel()

Specified by:

getModel in interface Path<T>

getResolvedModel

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

@Nonnull
public SqmBindableType<T> getExpressible()

Specified by:

getExpressible in interface SqmExpressibleAccessor<T>

Specified by:

getExpressible in interface SqmTypedNode<T>

getJavaTypeDescriptor

@Nonnull
public JavaType<T> getJavaTypeDescriptor()

Specified by:

getJavaTypeDescriptor in interface JpaTupleElement<T>

Specified by:

getJavaTypeDescriptor in interface SqmPath<T>

Overrides:

getJavaTypeDescriptor in class AbstractSqmExpression<T>

getNodeJavaType

@Nonnull
public JavaType<T> getNodeJavaType()

Description copied from interface: SqmTypedNode

The Java type descriptor for this node.

Specified by:

getNodeJavaType in interface SqmExpressibleAccessor<T>

Specified by:

getNodeJavaType in interface SqmTypedNode<T>

type

@Nonnull
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

@Nonnull
public <Y> SqmPath<Y> get(@Nonnull
 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 SqmPath<?> 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

@Nonnull
public <S extends T> SqmTreatedPath<T,S> treatAs(@Nonnull
 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

@Nonnull
public <S extends T> SqmTreatedPath<T,S> treatAs(@Nonnull
 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

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

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

Specified by:

treatAs in interface SqmPath<T>

treatAs

@Nonnull
public <S extends T> SqmTreatedPath<T,S> treatAs(@Nonnull
 EntityDomainType<S> treatTarget,
 @Nullable
 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

@Nonnull
public <Y> SqmPath<Y> get(@Nonnull
 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

@Nonnull
public <E, C extends Collection<E>>
SqmPluralPath<C,E> get(@Nonnull
 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

@Nonnull
public <K, V, M extends Map<K,V>>
SqmPluralPath<M,V> get(@Nonnull
 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>

get

@Nonnull
public <C extends Comparable<? super C>>
ComparableExpression<C> get(@Nonnull
 ComparableAttribute<? super T, C> attribute)

Specified by:

get in interface Path<T>

get

@Nonnull
public SqmBooleanPath get(@Nonnull
 BooleanAttribute<? super T> attribute)

Specified by:

get in interface Path<T>

get

@Nonnull
public <T1 extends Temporal & Comparable<? super T1>>
TemporalExpression<T1> get(@Nonnull
 TemporalAttribute<? super T, T1> attribute)

Specified by:

get in interface Path<T>

get

@Nonnull
public <N extends Number & Comparable<N>>
SqmNumericPath<N> get(@Nonnull
 NumericAttribute<? super T, N> attribute)

Specified by:

get in interface Path<T>

get

@Nonnull
public SqmTextPath get(@Nonnull
 TextAttribute<? super T> attribute)

Specified by:

get in interface Path<T>

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

toString

public String toString()

Overrides:

toString in class Object