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

Interface SqmJoin<L,R>

All Superinterfaces:

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

All Known Subinterfaces:

SqmAttributeJoin<O,T>, SqmCorrelatedJoin<L,R>, SqmCorrelatedSingularValuedJoin<L,R>, SqmSingularValuedJoin<L,R>, SqmTreatedAttributeJoin<L,R,R1>

All Known Implementing Classes:

AbstractSqmAttributeJoin, AbstractSqmJoin, AbstractSqmPluralJoin, SqmBagJoin, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedCteJoin, SqmCorrelatedDerivedJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmDerivedJoin, SqmEntityJoin, SqmFunctionJoin, SqmListJoin, SqmMapJoin, SqmPluralPartJoin, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEntityJoin, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedSetJoin, SqmTreatedSingularJoin

public interface SqmJoin<L,R>
extends SqmFrom<L,R>, JpaJoin<L,R>

Field Summary

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

log

Method Summary

Modifier and Type	Method	Description
SqmJoin<L,R>	copy(SqmCopyContext context)
<X> JpaCrossJoin<X>	crossJoin(Class<X> entityJavaType)
<X> JpaCrossJoin<X>	crossJoin(EntityDomainType<X> entity)
SqmPredicate	getJoinPredicate()	Obtain the join predicate
default SqmPredicate	getOn()
SqmJoinType	getSqmJoinType()	The type of join - inner, cross, etc
boolean	isImplicitlySelectable()	When applicable, whether this join should be included in an implicit select clause
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, SqmJoinType joinType)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral)
<E> SqmBagJoin<R,E>	join(CollectionAttribute<? super R,E> attribute)
<E> SqmBagJoin<R,E>	join(CollectionAttribute<? super R,E> attribute, JoinType jt)
<Y> JpaJoin<R,Y>	join(EntityType<Y> entity)
<Y> JpaJoin<R,Y>	join(EntityType<Y> entity, JoinType joinType)
<E> SqmListJoin<R,E>	join(ListAttribute<? super R,E> list)
<E> SqmListJoin<R,E>	join(ListAttribute<? super R,E> list, JoinType jt)
<K, V> SqmMapJoin<R,K,V>	join(MapAttribute<? super R,K,V> map)
<K, V> SqmMapJoin<R,K,V>	join(MapAttribute<? super R,K,V> map, JoinType jt)
<E> SqmSetJoin<R,E>	join(SetAttribute<? super R,E> set)
<E> SqmSetJoin<R,E>	join(SetAttribute<? super R,E> set, JoinType jt)
<A> SqmSingularJoin<R,A>	join(SingularAttribute<? super R,A> attribute)
<A> SqmSingularJoin<R,A>	join(SingularAttribute<? super R,A> attribute, JoinType jt)
default <X> JpaEntityJoin<R,X>	join(Class<X> entityJavaType, SqmJoinType joinType)
<X, Y> SqmAttributeJoin<X,Y>	join(String attributeName)
<X, Y> SqmAttributeJoin<X,Y>	join(String attributeName, JoinType jt)
<X> JpaEntityJoin<R,X>	join(EntityDomainType<X> entity)
<X> JpaEntityJoin<R,X>	join(EntityDomainType<X> entity, SqmJoinType joinType)
<X> JpaJoin<?,X>	join(JpaCteCriteria<X> cte)
<X> JpaJoin<?,X>	join(JpaCteCriteria<X> cte, SqmJoinType joinType)
<X, Y> SqmBagJoin<X,Y>	joinCollection(String attributeName)
<X, Y> SqmBagJoin<X,Y>	joinCollection(String attributeName, JoinType jt)
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery)
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery, SqmJoinType joinType)
<X, Y> SqmListJoin<X,Y>	joinList(String attributeName)
<X, Y> SqmListJoin<X,Y>	joinList(String attributeName, JoinType jt)
<X, K, V> SqmMapJoin<X,K,V>	joinMap(String attributeName)
<X, K, V> SqmMapJoin<X,K,V>	joinMap(String attributeName, JoinType jt)
<X, Y> SqmSetJoin<X,Y>	joinSet(String attributeName)
<X, Y> SqmSetJoin<X,Y>	joinSet(String attributeName, JoinType jt)
default SqmJoin<L,R>	on(Expression<Boolean> restriction)
default SqmJoin<L,R>	on(Predicate... restrictions)
default SqmJoin<L,R>	on(JpaExpression<Boolean> restriction)
default SqmJoin<L,R>	on(JpaPredicate... restrictions)
void	setJoinPredicate(SqmPredicate predicate)	Inject the join predicate
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(Class<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(EntityDomainType<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.
<S extends R> SqmTreatedJoin<L,R,S>	treatAs(EntityDomainType<S> treatTarget, String alias)

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

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

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, getJavaTypeDescriptor, getLhs, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, resolvePathPart, setExplicitAlias, treatAs, treatAs, 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

getSqmJoinType

SqmJoinType getSqmJoinType()

The type of join - inner, cross, etc

isImplicitlySelectable

boolean isImplicitlySelectable()

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

getJoinPredicate

SqmPredicate getJoinPredicate()

Obtain the join predicate

Returns:

The join predicate

setJoinPredicate

void setJoinPredicate(SqmPredicate predicate)

Inject the join predicate

Parameters:

predicate - The join predicate

join

<X,
Y> SqmAttributeJoin<X,Y> join(String attributeName)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<X,
Y> SqmAttributeJoin<X,Y> join(String attributeName,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

copy

SqmJoin<L,R> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<L>

Specified by:

copy in interface SqmFrom<L,R>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<L>

Specified by:

copy in interface SqmSelectableNode<L>

Specified by:

copy in interface SqmTypedNode<L>

treatAs

<S extends R> SqmTreatedJoin<L,R,S> treatAs(Class<S> treatAsType)

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 SqmPath<L>

treatAs

<S extends R> SqmTreatedJoin<L,R,S> treatAs(EntityDomainType<S> treatAsType)

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 SqmPath<L>

treatAs

<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 SqmPath<L>

treatAs

<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 SqmPath<L>

getOn

default SqmPredicate getOn()

Specified by:

getOn in interface Join<L,R>

on

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

Specified by:

on in interface JpaJoin<L,R>

on

default SqmJoin<L,R> on(Expression<Boolean> restriction)

Specified by:

on in interface Join<L,R>

Specified by:

on in interface JpaJoin<L,R>

on

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

Specified by:

on in interface JpaJoin<L,R>

on

default SqmJoin<L,R> on(Predicate... restrictions)

Specified by:

on in interface Join<L,R>

Specified by:

on in interface JpaJoin<L,R>

join

default <X> JpaEntityJoin<R,X> join(Class<X> entityJavaType,
 SqmJoinType joinType)

Specified by:

join in interface JpaFrom<L,R>

join

<Y> JpaJoin<R,Y> join(EntityType<Y> entity)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

join

<Y> JpaJoin<R,Y> join(EntityType<Y> entity,
 JoinType joinType)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaEntityJoin<R,X> join(EntityDomainType<X> entity)

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaEntityJoin<R,X> join(EntityDomainType<X> entity,
 SqmJoinType joinType)

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaDerivedJoin<X> join(Subquery<X> subquery)

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaDerivedJoin<X> join(Subquery<X> subquery,
 SqmJoinType joinType)

Specified by:

join in interface JpaFrom<L,R>

joinLateral

<X> JpaDerivedJoin<X> joinLateral(Subquery<X> subquery)

Specified by:

joinLateral in interface JpaFrom<L,R>

joinLateral

<X> JpaDerivedJoin<X> joinLateral(Subquery<X> subquery,
 SqmJoinType joinType)

Specified by:

joinLateral in interface JpaFrom<L,R>

join

<X> JpaDerivedJoin<X> join(Subquery<X> subquery,
 SqmJoinType joinType,
 boolean lateral)

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaJoin<?,X> join(JpaCteCriteria<X> cte)

Specified by:

join in interface JpaFrom<L,R>

join

<X> JpaJoin<?,X> join(JpaCteCriteria<X> cte,
 SqmJoinType joinType)

Specified by:

join in interface JpaFrom<L,R>

crossJoin

<X> JpaCrossJoin<X> crossJoin(Class<X> entityJavaType)

Specified by:

crossJoin in interface JpaFrom<L,R>

crossJoin

<X> JpaCrossJoin<X> crossJoin(EntityDomainType<X> entity)

Specified by:

crossJoin in interface JpaFrom<L,R>

join

<A> SqmSingularJoin<R,A> join(SingularAttribute<? super R,A> attribute)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<A> SqmSingularJoin<R,A> join(SingularAttribute<? super R,A> attribute,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmBagJoin<R,E> join(CollectionAttribute<? super R,E> attribute)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmBagJoin<R,E> join(CollectionAttribute<? super R,E> attribute,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmSetJoin<R,E> join(SetAttribute<? super R,E> set)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmSetJoin<R,E> join(SetAttribute<? super R,E> set,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmListJoin<R,E> join(ListAttribute<? super R,E> list)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<E> SqmListJoin<R,E> join(ListAttribute<? super R,E> list,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<K,
V> SqmMapJoin<R,K,V> join(MapAttribute<? super R,K,V> map)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

join

<K,
V> SqmMapJoin<R,K,V> join(MapAttribute<? super R,K,V> map,
 JoinType jt)

Specified by:

join in interface From<L,R>

Specified by:

join in interface JpaFrom<L,R>

Specified by:

join in interface SqmFrom<L,R>

joinCollection

<X,
Y> SqmBagJoin<X,Y> joinCollection(String attributeName)

Specified by:

joinCollection in interface From<L,R>

Specified by:

joinCollection in interface JpaFrom<L,R>

Specified by:

joinCollection in interface SqmFrom<L,R>

joinCollection

<X,
Y> SqmBagJoin<X,Y> joinCollection(String attributeName,
 JoinType jt)

Specified by:

joinCollection in interface From<L,R>

Specified by:

joinCollection in interface JpaFrom<L,R>

Specified by:

joinCollection in interface SqmFrom<L,R>

joinSet

<X,
Y> SqmSetJoin<X,Y> joinSet(String attributeName)

Specified by:

joinSet in interface From<L,R>

Specified by:

joinSet in interface JpaFrom<L,R>

Specified by:

joinSet in interface SqmFrom<L,R>

joinSet

<X,
Y> SqmSetJoin<X,Y> joinSet(String attributeName,
 JoinType jt)

Specified by:

joinSet in interface From<L,R>

Specified by:

joinSet in interface JpaFrom<L,R>

Specified by:

joinSet in interface SqmFrom<L,R>

joinList

<X,
Y> SqmListJoin<X,Y> joinList(String attributeName)

Specified by:

joinList in interface From<L,R>

Specified by:

joinList in interface JpaFrom<L,R>

Specified by:

joinList in interface SqmFrom<L,R>

joinList

<X,
Y> SqmListJoin<X,Y> joinList(String attributeName,
 JoinType jt)

Specified by:

joinList in interface From<L,R>

Specified by:

joinList in interface JpaFrom<L,R>

Specified by:

joinList in interface SqmFrom<L,R>

joinMap

<X,
K,
V> SqmMapJoin<X,K,V> joinMap(String attributeName)

Specified by:

joinMap in interface From<L,R>

Specified by:

joinMap in interface JpaFrom<L,R>

Specified by:

joinMap in interface SqmFrom<L,R>

joinMap

<X,
K,
V> SqmMapJoin<X,K,V> joinMap(String attributeName,
 JoinType jt)

Specified by:

joinMap in interface From<L,R>

Specified by:

joinMap in interface JpaFrom<L,R>

Specified by:

joinMap in interface SqmFrom<L,R>