Class AbstractSqmAttributeJoin<L,R>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

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

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

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

org.hibernate.query.sqm.tree.domain.AbstractSqmFrom<L,R>

org.hibernate.query.sqm.tree.domain.AbstractSqmJoin<L,R>

org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin<L,R>

All Implemented Interfaces:

Expression<R>, Fetch<L,R>, FetchParent<L,R>, From<L,R>, Join<L,R>, Path<R>, Selection<R>, TupleElement<R>, Serializable, JpaCriteriaNode, JpaExpression<R>, JpaFetch<L,R>, JpaFetchParent<L,R>, JpaFrom<L,R>, JpaJoin<L,R>, JpaPath<R>, JpaSelection<R>, JpaTupleElement<R>, SemanticPathPart, SqmPath<R>, SqmExpression<R>, SqmAttributeJoin<L,R>, SqmFrom<L,R>, SqmJoin<L,R>, SqmSelectableNode<R>, SqmCacheable, SqmExpressibleAccessor<R>, SqmNode, SqmTypedNode<R>, SqmVisitableNode

Direct Known Subclasses:

AbstractSqmPluralJoin, SqmSingularJoin

public abstract class AbstractSqmAttributeJoin<L,R>
extends AbstractSqmJoin<L,R>
implements SqmAttributeJoin<L,R>

Models a join based on a mapped attribute reference.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSqmAttributeJoin(SqmFrom<?,L> lhs, NavigablePath navigablePath, SqmPathSource<R> joinedNavigable, @Nullable String alias, SqmJoinType joinType, boolean fetchJoin, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
SqmAttributeJoin<L,R>	alias(String name)
void	clearFetched()
boolean	deepEquals(SqmFrom<?,?> object)
@NonNull PersistentAttribute<? super L, ?>	getAttribute()
JoinType	getJoinType()
@NonNull SqmFrom<?,L>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
@NonNull JavaType<R>	getNodeJavaType()	The Java type descriptor for this node.
@NonNull SqmFrom<?,L>	getParent()
boolean	isDeepCompatible(SqmFrom<?,?> object)
boolean	isFetched()	Is this a fetch join?
boolean	isImplicitJoin()	Is this an implicit join inferred from a path expression?
SqmAttributeJoin<L,R>	on(@Nullable JpaExpression<Boolean> restriction)	Add a restriction to the fetch.
SqmAttributeJoin<L,R>	on(JpaPredicate @Nullable ... restrictions)	Add a restriction to the fetch.
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(Class<S> treatJavaType, @Nullable String alias)
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(Class<S> treatJavaType, @Nullable String alias, boolean fetched)
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget, @Nullable String alias)
abstract <S extends R> SqmTreatedAttributeJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget, @Nullable String alias, boolean fetched)

Methods inherited from class AbstractSqmJoin

applyRestriction, copyTo, getJoinPredicate, getOn, getSqmJoinType, join, join, setJoinPredicate

Methods inherited from class AbstractSqmFrom

addSqmJoin, addTreat, appendHqlString, copyTo, createCorrelation, 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, 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 AbstractSqmPath

cacheHashCode, copyTo, equals, get, get, get, get, get, getExpressible, getJavaTypeDescriptor, getModel, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, hashCode, isCompatible, registerReusablePath, resolvePath, resolvePath, toString, type, visitReusablePaths

Methods inherited from class AbstractSqmExpression

applyInferableType, as, cast, equalTo, equalTo, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo

Methods inherited from class AbstractJpaSelection

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 From

getJoins, isCorrelated

Methods inherited from interface JpaFetch

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

Methods inherited from interface JpaFrom

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

Methods inherited from interface JpaPath

getParentPath

Methods inherited from interface JpaSelection

getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface Path

getModel

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmAttributeJoin

copy, getJavaTypeDescriptor, getJoinPredicate, getReferencedPathSource, isImplicitlySelectable, on, on, setJoinPredicate

Methods inherited from interface SqmCacheable

cacheHashCode, isCompatible

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 SqmFrom

addSqmJoin, getCorrelationParent, getNumberOfJoins, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, hasTreats, join, join, resolveAlias, visitSqmJoins

Methods inherited from interface SqmJoin

crossJoin, crossJoin, getOn, getSqmJoinType, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmPath

applyInferableType, findRoot, get, get, get, get, get, getExplicitAlias, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, resolvePathPart, setExplicitAlias, type, visitReusablePaths

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible

Methods inherited from interface SqmVisitableNode

appendHqlString, toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

AbstractSqmAttributeJoin

protected AbstractSqmAttributeJoin(SqmFrom<?,L> lhs,
 NavigablePath navigablePath,
 SqmPathSource<R> joinedNavigable,
 @Nullable String alias,
 SqmJoinType joinType,
 boolean fetchJoin,
 NodeBuilder nodeBuilder)

Method Details

isImplicitJoin

public boolean isImplicitJoin()

Description copied from interface: SqmAttributeJoin

Is this an implicit join inferred from a path expression?

Specified by:

isImplicitJoin in interface SqmAttributeJoin<L,R>

getLhs

public @NonNull SqmFrom<?,L> 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<L>

Specified by:

getLhs in interface SqmAttributeJoin<L,R>

Specified by:

getLhs in interface SqmPath<L>

Overrides:

getLhs in class AbstractSqmJoin<L,R>

getNodeJavaType

public @NonNull JavaType<R> getNodeJavaType()

Description copied from interface: SqmTypedNode

The Java type descriptor for this node.

Specified by:

getNodeJavaType in interface SqmExpressibleAccessor<L>

Specified by:

getNodeJavaType in interface SqmTypedNode<L>

Overrides:

getNodeJavaType in class AbstractSqmPath<R>

isFetched

public boolean isFetched()

Description copied from interface: SqmAttributeJoin

Is this a fetch join?

Specified by:

isFetched in interface SqmAttributeJoin<L,R>

alias

public SqmAttributeJoin<L,R> alias(String name)

Specified by:

alias in interface JpaSelection<L>

Specified by:

alias in interface Selection<L>

Overrides:

alias in class AbstractSqmFrom<L,R>

clearFetched

public void clearFetched()

Specified by:

clearFetched in interface SqmAttributeJoin<L,R>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

getAttribute

public @NonNull PersistentAttribute<? super L, ?> getAttribute()

Specified by:

getAttribute in interface Fetch<L,R>

Specified by:

getAttribute in interface Join<L,R>

Specified by:

getAttribute in interface JpaJoin<L,R>

Specified by:

getAttribute in interface SqmAttributeJoin<L,R>

on

public SqmAttributeJoin<L,R> on(@Nullable JpaExpression<Boolean> restriction)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<L,R>

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmAttributeJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

public SqmAttributeJoin<L,R> on(JpaPredicate @Nullable ... restrictions)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<L,R>

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmAttributeJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

getParent

public @NonNull SqmFrom<?,L> getParent()

Specified by:

getParent in interface Fetch<L,R>

Specified by:

getParent in interface Join<L,R>

Overrides:

getParent in class AbstractSqmJoin<L,R>

getJoinType

public JoinType getJoinType()

Specified by:

getJoinType in interface Fetch<L,R>

Specified by:

getJoinType in interface Join<L,R>

Overrides:

getJoinType in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(Class<S> treatJavaType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<L,R>

Specified by:

treatAs in interface JpaJoin<L,R>

Specified by:

treatAs in interface JpaPath<L>

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(EntityDomainType<S> treatTarget)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<L,R>

Specified by:

treatAs in interface JpaJoin<L,R>

Specified by:

treatAs in interface JpaPath<L>

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(Class<S> treatJavaType,
 @Nullable String alias)

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Specified by:

treatAs in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(EntityDomainType<S> treatTarget,
 @Nullable String alias)

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Specified by:

treatAs in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(Class<S> treatJavaType,
 @Nullable String alias,
 boolean fetched)

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Specified by:

treatAs in class AbstractSqmJoin<L,R>

treatAs

public abstract <S extends R>
SqmTreatedAttributeJoin<L,R,S> treatAs(EntityDomainType<S> treatTarget,
 @Nullable String alias,
 boolean fetched)

Specified by:

treatAs in interface SqmAttributeJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Specified by:

treatAs in class AbstractSqmJoin<L,R>

deepEquals

public boolean deepEquals(SqmFrom<?,?> object)

Specified by:

deepEquals in interface SqmFrom<L,R>

Overrides:

deepEquals in class AbstractSqmJoin<L,R>

isDeepCompatible

public boolean isDeepCompatible(SqmFrom<?,?> object)

Specified by:

isDeepCompatible in interface SqmFrom<L,R>

Overrides:

isDeepCompatible in class AbstractSqmJoin<L,R>