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

Interface SqmJoin<O,T>

All Superinterfaces:

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

All Known Subinterfaces:

SqmAttributeJoin<O,T>, SqmQualifiedJoin<O,T>

All Known Implementing Classes:

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

public interface SqmJoin<O,T>
extends SqmFrom<O,T>

Author:

Steve Ebersole

Field Summary

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

log

Method Summary

Modifier and Type	Method	Description
SqmJoin<O,T>	copy(SqmCopyContext context)
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, Y> SqmAttributeJoin<X,Y>	join(String attributeName)	Create an inner join to the specified attribute.
<X, Y> SqmAttributeJoin<X,Y>	join(String attributeName, JoinType jt)	Create a join to the specified attribute using the given join type.

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

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

addSqmJoin, getCorrelationParent, getReferencedPathSource, getSqmJoins, getSqmTreats, hasJoins, hasTreats, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet, treatAs, treatAs, treatAs, treatAs, 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, getExplicitAlias, getJavaTypeDescriptor, getLhs, 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

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

join

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

Description copied from interface: From

Create an inner join to the specified attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

join

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

Description copied from interface: From

Create a join to the specified attribute using the given join type.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

copy

SqmJoin<O,T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<O>

Specified by:

copy in interface SqmFrom<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>