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, SqmCacheable, 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 SqmNode

LOG

Method Summary

Modifier and Type	Method	Description
void	clearFetched()
SqmAttributeJoin<O,T>	copy(SqmCopyContext context)
PersistentAttribute<? super O, ?>	getAttribute()	Return the joined attribute.
JavaType<T>	getJavaTypeDescriptor()	Return the Java type of this tuple element.
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)	Set the join restriction.
default SqmJoin<O,T>	on(List<? extends Expression<Boolean>> restrictions)	Set the join restriction.
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 Fetch

getJoinType, getParent

Methods inherited from interface From

getJoinList, getJoins, isCorrelated

Methods inherited from interface Join

getJoinType, getParent

Methods inherited from interface JpaExpression

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

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 JpaJoin

treat

Methods inherited from interface JpaPath

getParentPath

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeIfKnown, 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, deepEquals, getCorrelationParent, getNumberOfJoins, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, hasTreats, isDeepCompatible, 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, joinCollection, joinCollection, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, on

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

Methods inherited from interface SqmVisitableNode

accept, appendHqlString, toHqlString

Methods inherited from interface TupleElement

getAlias

Method Details

getAttribute

@Nonnull
PersistentAttribute<? super O, ?> getAttribute()

Description copied from interface: JpaJoin

Return the joined attribute.

Specified by:

getAttribute in interface Fetch<O,T>

Specified by:

getAttribute in interface Join<O,T>

Specified by:

getAttribute in interface JpaJoin<O,T>

getLhs

@Nonnull
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

@Nonnull
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(SqmPath, SqmPathSource)

getJavaTypeDescriptor

@Nullable
JavaType<T> getJavaTypeDescriptor()

Description copied from interface: JpaTupleElement

Return the Java type of this tuple element.

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

@Nullable
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(@Nullable
 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

@Nonnull
default SqmJoin<O,T> on(@Nullable
 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

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

Description copied from interface: JpaJoin

Set the join 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

@Nonnull
default SqmJoin<O,T> on(@Nullable
 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

@Nonnull
default SqmJoin<O,T> on(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Description copied from interface: JpaJoin

Set the join 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>

treatAs

@Nonnull
<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(@Nonnull
 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

@Nonnull
<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(@Nonnull
 Class<S> treatJavaType,
 @Nullable
 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

@Nonnull
<S extends T> SqmTreatedAttributeJoin<O,T,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<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

@Nonnull
<S extends T> SqmTreatedAttributeJoin<O,T,S> treatAs(@Nonnull
 EntityDomainType<S> treatTarget,
 @Nullable
 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

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

Specified by:

treatAs in interface SqmPath<O>

treatAs

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

Specified by:

treatAs in interface SqmPath<O>

copy

@Nonnull
SqmAttributeJoin<O,T> copy(@Nonnull
 SqmCopyContext context)

Specified by:

copy in interface SqmExpression<O>

Specified by:

copy in interface SqmFrom<O,T>

Specified by:

copy in interface SqmJoin<O,T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<O>

Specified by:

copy in interface SqmSelectableNode<O>

Specified by:

copy in interface SqmTypedNode<O>