Top Description Fields Constructors Methods
org.hibernate.query.sqm.tree.domain

public abstract Class AbstractSqmAttributeJoin<O, T>

extends AbstractSqmQualifiedJoin<O, T>
implements SqmAttributeJoin<O, T>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.sqm.tree.from.SqmAttributeJoin, org.hibernate.query.criteria.JpaJoin, jakarta.persistence.criteria.Join, jakarta.persistence.criteria.From, jakarta.persistence.criteria.FetchParent, jakarta.persistence.criteria.Path, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement, org.hibernate.query.criteria.JpaJoinedFrom, org.hibernate.query.criteria.JpaFrom, org.hibernate.query.criteria.JpaFetchParent, org.hibernate.query.criteria.JpaPath, org.hibernate.query.criteria.JpaExpression, org.hibernate.query.criteria.JpaSelection, org.hibernate.query.criteria.JpaTupleElement, org.hibernate.query.criteria.JpaCriteriaNode, java.io.Serializable, org.hibernate.query.criteria.JpaFetch, jakarta.persistence.criteria.Fetch, org.hibernate.query.sqm.tree.from.SqmQualifiedJoin, org.hibernate.query.sqm.tree.from.SqmJoin, org.hibernate.query.sqm.tree.from.SqmFrom, org.hibernate.query.sqm.tree.domain.SqmPath, org.hibernate.query.hql.spi.SemanticPathPart, org.hibernate.query.sqm.tree.expression.SqmExpression, org.hibernate.query.sqm.tree.select.SqmSelectableNode, org.hibernate.query.sqm.tree.SqmTypedNode, org.hibernate.query.sqm.tree.SqmVisitableNode, org.hibernate.query.sqm.tree.SqmNode, org.hibernate.query.sqm.tree.SqmExpressibleAccessor
Known Direct Subclasses
org.hibernate.query.sqm.tree.domain.AbstractSqmPluralJoin, org.hibernate.query.sqm.tree.domain.SqmSingularJoin
Imports
org.hibernate.metamodel.model.domain.PersistentAttribute, org.hibernate.query.criteria.JpaExpression, .JpaPredicate, org.hibernate.query.sqm.NodeBuilder, .SemanticQueryWalker, .SqmJoinable, .SqmPathSource, org.hibernate.query.sqm.spi.SqmCreationHelper, org.hibernate.query.sqm.tree.SqmJoinType, org.hibernate.query.sqm.tree.from.SqmAttributeJoin, .SqmFrom, org.hibernate.spi.NavigablePath, org.hibernate.type.descriptor.java.JavaType, jakarta.persistence.criteria.Expression, .JoinType, .Predicate
Models a join based on a mapped attribute reference.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final boolean
fetched

Constructor Summary

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

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

Method Summary

Modifier and TypeMethod and Description
public <X> X
accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation
public PersistentAttribute<? super O, ?>
getAttribute()

Implements jakarta.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.JpaJoin.getAttribute.

Return the metamodel attribute corresponding to the fetch join.
public JoinType
getJoinType()

Implements jakarta.persistence.criteria.Fetch.getJoinType, jakarta.persistence.criteria.Join.getJoinType.

Return the join type used in the fetch join.
public SqmFrom<?, O>
getLhs()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getLhs.

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.getLhs, org.hibernate.query.sqm.tree.domain.SqmPath.getLhs, org.hibernate.query.criteria.JpaPath.getLhs.

Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
public JavaType<T>
getNodeJavaType()

Overrides default org.hibernate.query.sqm.tree.SqmTypedNode.getNodeJavaType.

The Java type descriptor for this node.
public SqmFrom<?, O>
getParent()

Implements jakarta.persistence.criteria.Fetch.getParent, jakarta.persistence.criteria.Join.getParent.

Return the parent of the fetched item.
public boolean
isFetched()

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.isFetched.

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

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Add a restriction to the fetch.
public SqmAttributeJoin<O, T>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public SqmAttributeJoin<O, T>
on(JpaPredicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Add a restriction to the fetch.
public SqmAttributeJoin<O, T>
on(Predicate...
zero or more restriction predicates
restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
Inherited from org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin:
applyRestrictioncopyTogetJoinPredicategetOnsetJoinPredicate

Field Detail

fetchedback to summary
private final boolean fetched

Constructor Detail

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

Method Detail

acceptback to summary
public <X> X accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation

Annotations
@Override
getAttributeback to summary
public PersistentAttribute<? super O, ?> getAttribute()

Implements jakarta.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.JpaJoin.getAttribute.

Doc from jakarta.persistence.criteria.Fetch.getAttribute.

Return the metamodel attribute corresponding to the fetch join.

Returns:PersistentAttribute<? super O, ?>

metamodel attribute for the join

Annotations
@Override
getJoinTypeback to summary
public JoinType getJoinType()

Implements jakarta.persistence.criteria.Fetch.getJoinType, jakarta.persistence.criteria.Join.getJoinType.

Doc from jakarta.persistence.criteria.Fetch.getJoinType.

Return the join type used in the fetch join.

Returns:JoinType

join type

Annotations
@Override
getLhsback to summary
public SqmFrom<?, O> getLhs()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getLhs.

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.getLhs, org.hibernate.query.sqm.tree.domain.SqmPath.getLhs, org.hibernate.query.criteria.JpaPath.getLhs.

Doc from org.hibernate.query.sqm.tree.domain.SqmPath.getLhs.

Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join

Annotations
@Override
getNodeJavaTypeback to summary
public JavaType<T> getNodeJavaType()

Overrides default org.hibernate.query.sqm.tree.SqmTypedNode.getNodeJavaType.

Doc from org.hibernate.query.sqm.tree.SqmTypedNode.getNodeJavaType.

The Java type descriptor for this node.

Annotations
@Override
getParentback to summary
public SqmFrom<?, O> getParent()

Implements jakarta.persistence.criteria.Fetch.getParent, jakarta.persistence.criteria.Join.getParent.

Doc from jakarta.persistence.criteria.Fetch.getParent.

Return the parent of the fetched item.

Returns:SqmFrom<?, O>

fetch parent

Annotations
@Override
isFetchedback to summary
public boolean isFetched()

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.isFetched.

onback to summary
public SqmAttributeJoin<O, T> on(JpaExpression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from org.hibernate.query.criteria.JpaFetch.on.

Add a restriction to the fetch.

Annotations
@Override
onback to summary
public SqmAttributeJoin<O, T> on(Expression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from jakarta.persistence.criteria.Join.on.

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.

Parameters
restriction:Expression<Boolean>

a simple or compound boolean expression

Returns:SqmAttributeJoin<O, T>

the modified join object

Annotations
@Override
onback to summary
public SqmAttributeJoin<O, T> on(JpaPredicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from org.hibernate.query.criteria.JpaFetch.on.

Add a restriction to the fetch.

Annotations
@Override
onback to summary
public SqmAttributeJoin<O, T> on(Predicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin.on.

Implements org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from jakarta.persistence.criteria.Join.on.

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.

Parameters
restrictions:Predicate[]

zero or more restriction predicates

Returns:SqmAttributeJoin<O, T>

the modified join object

Annotations
@Override