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

Class AbstractSqmJoin<L,R>

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>

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

Direct Known Subclasses:

AbstractSqmAttributeJoin, SqmCteJoin, SqmDerivedJoin, SqmEntityJoin, 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 org.hibernate.query.sqm.tree.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)
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
<X> SqmEntityJoin<R,X>	join(Class<X> targetEntityClass)
<X> SqmEntityJoin<R,X>	join(Class<X> targetEntityClass, SqmJoinType joinType)
SqmJoin<L,R>	on(Expression<Boolean> restriction)
SqmJoin<L,R>	on(Predicate... 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 org.hibernate.query.sqm.tree.domain.AbstractSqmFrom

addSqmJoin, addTreat, alias, appendHqlString, copyTo, createCorrelation, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getParentPath, getSqmJoins, getSqmTreats, hasJoins, 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, joinCollection, joinCollection, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, removeLeftFetchJoins, resolvePathPart, setExplicitAlias, visitSqmJoins

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmPath

copyTo, get, get, get, get, getExpressible, getModel, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, registerReusablePath, resolvePath, resolvePath, toString, type, visitReusablePaths

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

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 jakarta.persistence.criteria.From

getJoins, isCorrelated

Methods inherited from interface org.hibernate.query.criteria.JpaFetchParent

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

Methods inherited from interface org.hibernate.query.criteria.JpaJoin

getAttribute

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.from.SqmFrom

addSqmJoin, getCorrelationParent, getReferencedPathSource, getSqmJoins, getSqmTreats, hasJoins, hasTreats, join, visitSqmJoins

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

copy, crossJoin, crossJoin, isImplicitlySelectable, 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 org.hibernate.query.sqm.tree.SqmNode

asLoggableText, nodeBuilder

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

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

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

Constructor Details

AbstractSqmJoin

public AbstractSqmJoin(NavigablePath navigablePath,
 SqmPathSource<R> referencedNavigable,
 SqmFrom<?,L> lhs,
 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

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(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)

copyTo

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

treatAs

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

public <S extends R> SqmTreatedJoin<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 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

public abstract <S extends R> SqmTreatedJoin<L,R,S> treatAs(Class<S> treatJavaType,
 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

public abstract <S extends R> SqmTreatedJoin<L,R,S> treatAs(EntityDomainType<S> treatTarget,
 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

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

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmFrom<L,R>

treatAs

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

Specified by:

treatAs in interface SqmPath<L>

Overrides:

treatAs in class AbstractSqmFrom<L,R>

getLhs

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

public SqmFrom<?,L> getParent()

Specified by:

getParent in interface Join<L,R>

getJoinType

public JoinType getJoinType()

Specified by:

getJoinType in interface Join<L,R>

getOn

public SqmPredicate getOn()

Specified by:

getOn in interface Join<L,R>

Specified by:

getOn in interface SqmJoin<L,R>

on

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

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

public SqmJoin<L,R> on(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

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

Specified by:

on in interface JpaJoin<L,R>

Specified by:

on in interface SqmJoin<L,R>

on

public SqmJoin<L,R> on(Predicate... 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>

join

public <X> SqmEntityJoin<R,X> join(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

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

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmJoin<L,R>

Overrides:

join in class AbstractSqmFrom<L,R>