Package org.hibernate.query.sqm.tree.from

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

org.hibernate.query.sqm.tree.domain.AbstractSqmFrom<O,T>

org.hibernate.query.sqm.tree.domain.AbstractSqmJoin<O,T>

org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin<T,T>

org.hibernate.query.sqm.tree.from.SqmEntityJoin<T>

All Implemented Interfaces:

Expression<T>, FetchParent<T,T>, From<T,T>, Path<T>, Selection<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaEntityJoin<T>, JpaExpression<T>, JpaFetchParent<T,T>, JpaFrom<T,T>, JpaJoinedFrom<T,T>, JpaPath<T>, JpaSelection<T>, JpaTupleElement<T>, SemanticPathPart, SqmPath<T>, SqmExpression<T>, SqmFrom<T,T>, SqmJoin<T,T>, SqmQualifiedJoin<T,T>, SqmSelectableNode<T>, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

Direct Known Subclasses:

SqmCorrelatedEntityJoin, SqmTreatedEntityJoin

public class SqmEntityJoin<T>
extends AbstractSqmQualifiedJoin<T,T>
implements JpaEntityJoin<T>

Author:

Steve Ebersole

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqmEntityJoin(EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)
protected	SqmEntityJoin(NavigablePath navigablePath, EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
SqmEntityJoin<T>	copy(SqmCopyContext context)
SqmCorrelatedEntityJoin<T>	createCorrelation()
SqmRoot<?>	findRoot()
String	getEntityName()
SqmPath<?>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
EntityDomainType<T>	getModel()	Return the bindable object that corresponds to the path expression.
EntityDomainType<T>	getReferencedPathSource()	The path source that this path refers to (and that most likely created it).
SqmRoot<?>	getRoot()
boolean	isImplicitlySelectable()	When applicable, whether this join should be included in an implicit select clause
SqmEntityJoin<T>	makeCopy(SqmCreationProcessingState creationProcessingState)
SqmEntityJoin<T>	on(Expression<Boolean> restriction)
SqmEntityJoin<T>	on(Predicate... restrictions)
SqmEntityJoin<T>	on(JpaExpression<Boolean> restriction)
SqmEntityJoin<T>	on(JpaPredicate... restrictions)
SqmPath<?>	resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)
<S extends T> SqmTreatedEntityJoin<T,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmFrom<?,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends T> SqmTreatedEntityJoin<T,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmFrom<?,S>	treatAs(EntityDomainType<S> treatTarget, String alias)

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

applyRestriction, copyTo, getJoinPredicate, getOn, setJoinPredicate

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

getSqmJoinType

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

addSqmJoin, addTreat, alias, appendHqlString, copyTo, 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, 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, getNavigablePath, getNavigablePathCopy, getNodeType, 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, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder

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

crossJoin, crossJoin, join, join, join, join, join, join, join, join, join, joinLateral, joinLateral

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

getOn

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, visitSubSelectableNodes

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

addSqmJoin, getCorrelationParent, getSqmJoins, getSqmTreats, hasJoins, hasTreats, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet, visitSqmJoins

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

getSqmJoinType, join, join

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

asLoggableText, nodeBuilder

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

applyInferableType, get, get, get, get, getExplicitAlias, getJavaTypeDescriptor, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveAlias, 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

appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

SqmEntityJoin

public SqmEntityJoin(EntityDomainType<T> joinedEntityDescriptor,
 String alias,
 SqmJoinType joinType,
 SqmRoot<?> sqmRoot)

SqmEntityJoin

protected SqmEntityJoin(NavigablePath navigablePath,
 EntityDomainType<T> joinedEntityDescriptor,
 String alias,
 SqmJoinType joinType,
 SqmRoot<?> sqmRoot)

Method Details

isImplicitlySelectable

public boolean isImplicitlySelectable()

Description copied from interface: SqmJoin

When applicable, whether this join should be included in an implicit select clause

Specified by:

isImplicitlySelectable in interface SqmJoin<T,T>

copy

public SqmEntityJoin<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmFrom<T,T>

Specified by:

copy in interface SqmJoin<T,T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<T>

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>

getRoot

public SqmRoot<?> getRoot()

findRoot

public SqmRoot<?> findRoot()

Specified by:

findRoot in interface SqmPath<T>

resolveIndexedAccess

public SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolveIndexedAccess in interface SemanticPathPart

Specified by:

resolveIndexedAccess in interface SqmPath<T>

getModel

public EntityDomainType<T> getModel()

Description copied from interface: Path

Return the bindable object that corresponds to the path expression.

Specified by:

getModel in interface JpaEntityJoin<T>

Specified by:

getModel in interface Path<T>

Overrides:

getModel in class AbstractSqmPath<T>

Returns:

bindable object corresponding to the path

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>

Overrides:

getLhs in class AbstractSqmPath<T>

getReferencedPathSource

public EntityDomainType<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 SqmFrom<T,T>

Specified by:

getReferencedPathSource in interface SqmPath<T>

Overrides:

getReferencedPathSource in class AbstractSqmPath<T>

See Also:

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

getEntityName

public String getEntityName()

on

public SqmEntityJoin<T> on(JpaExpression<Boolean> restriction)

Specified by:

on in interface JpaEntityJoin<T>

Specified by:

on in interface JpaJoinedFrom<T,T>

Overrides:

on in class AbstractSqmQualifiedJoin<T,T>

on

public SqmEntityJoin<T> on(Expression<Boolean> restriction)

Specified by:

on in interface JpaEntityJoin<T>

Specified by:

on in interface JpaJoinedFrom<T,T>

Overrides:

on in class AbstractSqmQualifiedJoin<T,T>

on

public SqmEntityJoin<T> on(JpaPredicate... restrictions)

Specified by:

on in interface JpaEntityJoin<T>

Specified by:

on in interface JpaJoinedFrom<T,T>

Overrides:

on in class AbstractSqmQualifiedJoin<T,T>

on

public SqmEntityJoin<T> on(Predicate... restrictions)

Specified by:

on in interface JpaEntityJoin<T>

Specified by:

on in interface JpaJoinedFrom<T,T>

Overrides:

on in class AbstractSqmQualifiedJoin<T,T>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

treatAs

public <S extends T> SqmTreatedEntityJoin<T,S> treatAs(Class<S> treatJavaType)
                                                throws PathException

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

Specified by:

treatAs in interface SqmPath<T>

Throws:

PathException

treatAs

public <S extends T> SqmTreatedEntityJoin<T,S> treatAs(EntityDomainType<S> treatTarget)
                                                throws PathException

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

Specified by:

treatAs in interface SqmPath<T>

Throws:

PathException

treatAs

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

Specified by:

treatAs in interface SqmFrom<T,T>

treatAs

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

Specified by:

treatAs in interface SqmFrom<T,T>

createCorrelation

public SqmCorrelatedEntityJoin<T> createCorrelation()

Specified by:

createCorrelation in class AbstractSqmFrom<T,T>

makeCopy

public SqmEntityJoin<T> makeCopy(SqmCreationProcessingState creationProcessingState)