Class AbstractSqmJoin<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>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSqmAttributeJoin, SqmCteJoin, SqmDerivedJoin, SqmEntityJoin, SqmFunctionJoin, SqmPluralPartJoin

public abstract class AbstractSqmJoin<L,R>
extends AbstractSqmFrom<L,R>
implements SqmJoin<L,R>

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractSqmJoin(NavigablePath navigablePath, SqmPathSource<R> referencedNavigable, SqmFrom<?,L> lhs, String alias, SqmJoinType joinType, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
void	applyRestriction(SqmPredicate restriction)
protected void	copyTo(AbstractSqmJoin<L,R> target, SqmCopyContext context)
boolean	deepEquals(SqmFrom<?,?> object)
SqmPredicate	getJoinPredicate()	Obtain the join predicate
JoinType	getJoinType()
SqmFrom<?,L>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
SqmPredicate	getOn()
SqmFrom<?,L>	getParent()
SqmJoinType	getSqmJoinType()	The type of join - inner, cross, etc
boolean	isDeepCompatible(SqmFrom<?,?> object)
<X> SqmEntityJoin<R,X>	join(Class<X> targetEntityClass)
<X> SqmEntityJoin<R,X>	join(Class<X> targetEntityClass, SqmJoinType joinType)
SqmJoin<L,R>	on(BooleanExpression... restrictions)
SqmJoin<L,R>	on(Expression<Boolean> restriction)
SqmJoin<L,R>	on(List<? extends Expression<Boolean>> restrictions)
SqmJoin<L,R>	on(JpaExpression<Boolean> restriction)
SqmJoin<L,R>	on(JpaPredicate... restrictions)
void	setJoinPredicate(SqmPredicate predicate)	Inject the join predicate
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(Class<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
abstract <S extends R> SqmTreatedJoin<L,R,S>	treatAs(Class<S> treatJavaType, String alias)
abstract <S extends R> SqmTreatedJoin<L,R,S>	treatAs(Class<S> treatJavaType, String alias, boolean fetched)
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
abstract <S extends R> SqmTreatedJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
abstract <S extends R> SqmTreatedJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetched)

Methods inherited from class AbstractSqmFrom

addSqmJoin, addTreat, alias, appendHqlString, copyTo, createCorrelation, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoinList, 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, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinCollection, joinCollection, joinLateral, 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, get, get, get, get, get, getExpressible, getJavaTypeDescriptor, getModel, getNavigablePath, getNavigablePathCopy, getNodeJavaType, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, hashCode, isCompatible, registerReusablePath, resolvePath, resolvePath, toString, type, visitReusablePaths

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

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

getJoinList, getJoins, isCorrelated

Methods inherited from interface JpaExpression

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

Methods inherited from interface JpaFetchParent

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 JpaJoin

getAttribute, treat

Methods inherited from interface JpaPath

getParentPath

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface Path

get, get, get, get, get, getModel

Methods inherited from interface Selection

isCompoundSelection

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, getReferencedPathSource, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, hasTreats, join, resolveAlias, visitSqmJoins

Methods inherited from interface SqmJoin

copy, crossJoin, crossJoin, isImplicitlySelectable, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, 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, getJavaTypeDescriptor, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, resolvePathPart, setExplicitAlias, type, visitReusablePaths

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

accept, appendHqlString, toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

AbstractSqmJoin

public AbstractSqmJoin(NavigablePath navigablePath,
 SqmPathSource<R> referencedNavigable,
 SqmFrom<?,L> lhs,
 @Nullable
 String alias,
 SqmJoinType joinType,
 NodeBuilder nodeBuilder)

Method Details

getSqmJoinType

public SqmJoinType getSqmJoinType()

Description copied from interface: SqmJoin

The type of join - inner, cross, etc

Specified by:

getSqmJoinType in interface SqmJoin<L,R>

getJoinPredicate

@Nullable
public SqmPredicate getJoinPredicate()

Description copied from interface: SqmJoin

Obtain the join predicate

Specified by:

getJoinPredicate in interface SqmJoin<L,R>

Returns:

The join predicate

setJoinPredicate

public void setJoinPredicate(@Nullable
 SqmPredicate predicate)

Description copied from interface: SqmJoin

Inject the join predicate

Specified by:

setJoinPredicate in interface SqmJoin<L,R>

Parameters:

predicate - The join predicate

applyRestriction

public void applyRestriction(SqmPredicate restriction)

on

@Nonnull
public SqmJoin<L,R> on(@Nonnull
 BooleanExpression... restrictions)

Specified by:

on in interface Join<L,R>

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

@Nonnull
public SqmJoin<L,R> on(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Specified by:

on in interface Join<L,R>

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

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

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

@Nonnull
public SqmJoin<L,R> on(@Nonnull
 Expression<Boolean> restriction)

Specified by:

on in interface Join<L,R>

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

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

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

copyTo

protected void copyTo(AbstractSqmJoin<L,R> target,
 SqmCopyContext context)

treatAs

@Nonnull
public <S extends R> SqmTreatedJoin<L,R,S> treatAs(@Nonnull
 Class<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 SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmFrom<L,R>

treatAs

@Nonnull
public <S extends R> SqmTreatedJoin<L,R,S> treatAs(@Nonnull
 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 SqmFrom<L,R>

Specified by:

treatAs in interface SqmJoin<L,R>

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmFrom<L,R>

treatAs

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

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 AbstractSqmFrom<L,R>

treatAs

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

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 AbstractSqmFrom<L,R>

treatAs

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

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmFrom<L,R>

treatAs

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

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmPath<R>

getLhs

@Nullable
public 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 SqmPath<L>

Overrides:

getLhs in class AbstractSqmPath<R>

getParent

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

Specified by:

getParent in interface Join<L,R>

getJoinType

@Nonnull
public JoinType getJoinType()

Specified by:

getJoinType in interface Join<L,R>

getOn

@Nullable
public SqmPredicate getOn()

Specified by:

getOn in interface Join<L,R>

Specified by:

getOn in interface SqmJoin<L,R>

join

@Nonnull
public <X> SqmEntityJoin<R,X> join(@Nonnull
 Class<X> targetEntityClass)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

Overrides:

join in class AbstractSqmFrom<L,R>

join

@Nonnull
public <X> SqmEntityJoin<R,X> join(@Nonnull
 Class<X> targetEntityClass,
 @Nonnull
 SqmJoinType joinType)

Specified by:

join in interface SqmJoin<L,R>

Overrides:

join in class AbstractSqmFrom<L,R>

deepEquals

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

Specified by:

deepEquals in interface SqmFrom<L,R>

Overrides:

deepEquals in class AbstractSqmFrom<L,R>

isDeepCompatible

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

Specified by:

isDeepCompatible in interface SqmFrom<L,R>

Overrides:

isDeepCompatible in class AbstractSqmFrom<L,R>