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

Interface SqmAttributeJoin<O,T>

All Superinterfaces:

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

All Known Subinterfaces:

SqmTreatedAttributeJoin<L,R,R1>

All Known Implementing Classes:

AbstractSqmAttributeJoin, AbstractSqmPluralJoin, SqmBagJoin, SqmCorrelatedBagJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmListJoin, SqmMapJoin, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedSetJoin, SqmTreatedSingularJoin

public interface SqmAttributeJoin<O,T>
extends SqmJoin<O,T>, JpaFetch<O,T>, JpaJoin<O,T>

Models a join based on a mapped attribute reference.

Field Summary

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

log

Method Summary

Modifier and Type	Method	Description
void	clearFetched()
JavaType<T>	getJavaTypeDescriptor()
SqmPredicate	getJoinPredicate()	Obtain the join predicate
SqmFrom<?,O>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
SqmPathSource<T>	getReferencedPathSource()	The Navigable for an SqmFrom will always be a NavigableContainer The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).
boolean	isFetched()	Is this a fetch join?
boolean	isImplicitJoin()	Is this an implicit join inferred from a path expression?
default boolean	isImplicitlySelectable()	When applicable, whether this join should be included in an implicit select clause
default SqmJoin<O,T>	on(Expression<Boolean> restriction)
default SqmJoin<O,T>	on(Predicate... restrictions)
default SqmJoin<O,T>	on(JpaExpression<Boolean> restriction)	Add a restriction to the fetch.
default SqmJoin<O,T>	on(JpaPredicate... restrictions)	Add a restriction to the fetch.
void	setJoinPredicate(SqmPredicate predicate)	Inject the join predicate
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(Class<S> treatTarget, String alias, boolean fetch)
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
<S extends T> SqmTreatedAttributeJoin<O,T,S>	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)

Methods inherited from interface jakarta.persistence.criteria.Fetch

getAttribute, getJoinType, getParent

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

Methods inherited from interface jakarta.persistence.criteria.Join

getJoinType, getParent

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

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

Methods inherited from interface org.hibernate.query.criteria.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 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, getNumberOfJoins, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, hasTreats, join, join, resolveAlias, visitSqmJoins

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

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

Method Details

getLhs

SqmFrom<?,O> 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<O>

Specified by:

getLhs in interface SqmPath<O>

isImplicitlySelectable

default 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<O,T>

getReferencedPathSource

SqmPathSource<T> getReferencedPathSource()

Description copied from interface: SqmFrom

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).

Specified by:

getReferencedPathSource in interface SqmFrom<O,T>

Specified by:

getReferencedPathSource in interface SqmPath<O>

Returns:

See Also:

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

getJavaTypeDescriptor

JavaType<T> getJavaTypeDescriptor()

Specified by:

getJavaTypeDescriptor in interface JpaTupleElement<O>

Specified by:

getJavaTypeDescriptor in interface SqmPath<O>

isFetched

boolean isFetched()

Is this a fetch join?

isImplicitJoin

boolean isImplicitJoin()

Is this an implicit join inferred from a path expression?

clearFetched

@Internal
void clearFetched()

getJoinPredicate

SqmPredicate getJoinPredicate()

Description copied from interface: SqmJoin

Obtain the join predicate

Specified by:

getJoinPredicate in interface SqmJoin<O,T>

Returns:

The join predicate

setJoinPredicate

void setJoinPredicate(SqmPredicate predicate)

Description copied from interface: SqmJoin

Inject the join predicate

Specified by:

setJoinPredicate in interface SqmJoin<O,T>

Parameters:

predicate - The join predicate

on

default SqmJoin<O,T> on(JpaExpression<Boolean> restriction)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface SqmJoin<O,T>

on

default SqmJoin<O,T> on(Expression<Boolean> restriction)

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface SqmJoin<O,T>

on

default SqmJoin<O,T> on(JpaPredicate... restrictions)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface SqmJoin<O,T>

on

default SqmJoin<O,T> on(Predicate... restrictions)

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface SqmJoin<O,T>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(Class<S> treatJavaType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<O,T>

Specified by:

treatAs in interface JpaJoin<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmJoin<O,T>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(Class<S> treatJavaType,
 String alias)

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmJoin<O,T>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(EntityDomainType<S> treatTarget)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<O,T>

Specified by:

treatAs in interface JpaJoin<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmJoin<O,T>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(EntityDomainType<S> treatTarget,
 String alias)

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmJoin<O,T>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(EntityDomainType<S> treatTarget,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(Class<S> treatTarget,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<O>