Package org.hibernate.query.sqm.tree.domain

Class AbstractSqmAttributeJoin<O,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<O,T>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSqmPluralJoin, SqmSingularJoin

public abstract class AbstractSqmAttributeJoin<O,T>
extends AbstractSqmQualifiedJoin<O,T>
implements SqmAttributeJoin<O,T>

Models a join based on a mapped attribute reference.

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
	AbstractSqmAttributeJoin(SqmFrom<?,O> lhs, SqmJoinable joinedNavigable, String alias, SqmJoinType joinType, boolean fetched, NodeBuilder nodeBuilder)
protected	AbstractSqmAttributeJoin(SqmFrom<?,O> lhs, NavigablePath navigablePath, SqmJoinable joinedNavigable, String alias, SqmJoinType joinType, boolean fetched, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
JpaSelection<T>	alias(String name)	Assigns an alias to the selection item.
void	clearFetched()
PersistentAttribute<? super O,?>	getAttribute()	Return the metamodel attribute corresponding to the fetch join.
JoinType	getJoinType()	Return the join type used in the fetch join.
SqmFrom<?,O>	getLhs()	Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
JavaType<T>	getNodeJavaType()	The Java type descriptor for this node.
SqmFrom<?,O>	getParent()	Return the parent of the fetched item.
boolean	isFetched()
SqmAttributeJoin<O,T>	on(Expression<Boolean> restriction)	Modify the join to restrict the result according to the specified ON condition and return the join object.
SqmAttributeJoin<O,T>	on(Predicate... restrictions)	Modify the join to restrict the result according to the specified ON condition and return the join object.
SqmAttributeJoin<O,T>	on(JpaExpression<Boolean> restriction)	Add a restriction to the fetch.
SqmAttributeJoin<O,T>	on(JpaPredicate... restrictions)	Add a restriction to the fetch.

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, appendHqlString, copyTo, createCorrelation, 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, getModel, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, 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 jakarta.persistence.criteria.Join

getOn

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

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

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.from.SqmAttributeJoin

getJavaTypeDescriptor, getJoinPredicate, getReferencedPathSource, isImplicitlySelectable, makeCopy, setJoinPredicate, treatAs, treatAs, treatAs, treatAs, treatAs, treatAs

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

copy, 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, findRoot, get, get, get, get, getExplicitAlias, 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

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

appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

AbstractSqmAttributeJoin

public AbstractSqmAttributeJoin(SqmFrom<?,O> lhs,
 SqmJoinable joinedNavigable,
 String alias,
 SqmJoinType joinType,
 boolean fetched,
 NodeBuilder nodeBuilder)

AbstractSqmAttributeJoin

protected AbstractSqmAttributeJoin(SqmFrom<?,O> lhs,
 NavigablePath navigablePath,
 SqmJoinable joinedNavigable,
 String alias,
 SqmJoinType joinType,
 boolean fetched,
 NodeBuilder nodeBuilder)

Method Details

getLhs

public 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 SqmAttributeJoin<O,T>

Specified by:

getLhs in interface SqmPath<O>

Overrides:

getLhs in class AbstractSqmPath<T>

getNodeJavaType

public JavaType<T> getNodeJavaType()

Description copied from interface: SqmTypedNode

The Java type descriptor for this node.

Specified by:

getNodeJavaType in interface SqmExpressibleAccessor<O>

Specified by:

getNodeJavaType in interface SqmTypedNode<O>

isFetched

public boolean isFetched()

Specified by:

isFetched in interface SqmAttributeJoin<O,T>

alias

public JpaSelection<T> alias(String name)

Description copied from interface: Selection

Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.

Specified by:

alias in interface JpaSelection<O>

Specified by:

alias in interface Selection<O>

Overrides:

alias in class AbstractSqmFrom<O,T>

Parameters:

name - alias

Returns:

selection item

clearFetched

public void clearFetched()

Specified by:

clearFetched in interface SqmAttributeJoin<O,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

getAttribute

public PersistentAttribute<? super O,?> getAttribute()

Description copied from interface: Fetch

Return the metamodel attribute corresponding to the fetch join.

Specified by:

getAttribute in interface Fetch<O,T>

Specified by:

getAttribute in interface Join<O,T>

Specified by:

getAttribute in interface JpaJoin<O,T>

Returns:

metamodel attribute for the join

on

public SqmAttributeJoin<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 JpaJoinedFrom<O,T>

Overrides:

on in class AbstractSqmQualifiedJoin<O,T>

on

public SqmAttributeJoin<O,T> on(Expression<Boolean> restriction)

Description copied from interface: Join

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Overrides:

on in class AbstractSqmQualifiedJoin<O,T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified join object

on

public SqmAttributeJoin<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 JpaJoinedFrom<O,T>

Overrides:

on in class AbstractSqmQualifiedJoin<O,T>

on

public SqmAttributeJoin<O,T> on(Predicate... restrictions)

Description copied from interface: Join

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Overrides:

on in class AbstractSqmQualifiedJoin<O,T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified join object

getParent

public SqmFrom<?,O> getParent()

Description copied from interface: Fetch

Return the parent of the fetched item.

Specified by:

getParent in interface Fetch<O,T>

Specified by:

getParent in interface Join<O,T>

Returns:

fetch parent

getJoinType

public JoinType getJoinType()

Description copied from interface: Fetch

Return the join type used in the fetch join.

Specified by:

getJoinType in interface Fetch<O,T>

Specified by:

getJoinType in interface Join<O,T>

Returns:

join type