Top Fields Constructors Methods
org.hibernate.query.sqm.tree.from

public Class SqmEntityJoin<T>

extends AbstractSqmQualifiedJoin<T, T>
implements JpaEntityJoin<T>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.criteria.JpaEntityJoin, org.hibernate.query.criteria.JpaJoinedFrom, org.hibernate.query.criteria.JpaFrom, 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.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
Known Direct Subclasses
org.hibernate.query.sqm.tree.domain.SqmCorrelatedEntityJoin, org.hibernate.query.sqm.tree.domain.SqmTreatedEntityJoin
Imports
org.hibernate.metamodel.model.domain.EntityDomainType, org.hibernate.query.criteria.JpaExpression, .JpaJoinedFrom, .JpaPredicate, .JpaEntityJoin, org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin, .SqmCorrelatedEntityJoin, .SqmPath, .SqmTreatedEntityJoin, org.hibernate.spi.NavigablePath, org.hibernate.query.PathException, org.hibernate.query.hql.spi.SqmCreationProcessingState, .SqmCreationState, .SqmPathRegistry, org.hibernate.query.sqm.SemanticQueryWalker, org.hibernate.query.sqm.spi.SqmCreationHelper, org.hibernate.query.sqm.tree.SqmCopyContext, .SqmJoinType, org.hibernate.query.sqm.tree.expression.SqmExpression, jakarta.persistence.criteria.Expression, .Predicate
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final SqmRoot<?>
sqmRoot

Constructor Summary

AccessConstructor and Description
public
SqmEntityJoin(EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)

protected
SqmEntityJoin(NavigablePath navigablePath, EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)

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 SqmEntityJoin<T>
copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmJoin.copy, org.hibernate.query.sqm.tree.from.SqmFrom.copy, org.hibernate.query.sqm.tree.domain.SqmPath.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

public SqmCorrelatedEntityJoin<T>
createCorrelation()

Implements abstract org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.createCorrelation.

public SqmRoot<?>
findRoot()

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.findRoot.

public String
getEntityName()

public SqmPath<?>
getLhs()

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

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

The source (think "left hand side") of this path
public EntityDomainType<T>
getModel()

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

Implements org.hibernate.query.criteria.JpaEntityJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Return the bindable object that corresponds to the path expression.
public EntityDomainType<T>
getReferencedPathSource()

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

Implements org.hibernate.query.sqm.tree.from.SqmFrom.getReferencedPathSource, org.hibernate.query.sqm.tree.domain.SqmPath.getReferencedPathSource.

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).
public SqmRoot<?>
getRoot()

public boolean
isImplicitlySelectable()

Implements org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

When applicable, whether this join should be included in an implicit select clause
public SqmEntityJoin<T>
makeCopy(SqmCreationProcessingState creationProcessingState)

public SqmEntityJoin<T>
on(JpaExpression<Boolean> restriction)

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

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

public SqmEntityJoin<T>
on(Expression<Boolean> restriction)

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

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

public SqmEntityJoin<T>
on(JpaPredicate... restrictions)

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

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

public SqmEntityJoin<T>
on(Predicate... restrictions)

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

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

public SqmPath<?>
resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.resolveIndexedAccess.

public <S extends T> SqmTreatedEntityJoin<T, S>
treatAs(Class<S> treatJavaType)

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends T> SqmTreatedEntityJoin<T, S>
treatAs(EntityDomainType<S> treatTarget)

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends T> SqmFrom<?, S>
treatAs(Class<S> treatJavaType, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

public <S extends T> SqmFrom<?, S>
treatAs(EntityDomainType<S> treatTarget, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Inherited from org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin:
applyRestrictioncopyTogetJoinPredicategetOnsetJoinPredicate

Field Detail

sqmRootback to summary
private final SqmRoot<?> sqmRoot

Constructor Detail

SqmEntityJoinback to summary
public SqmEntityJoin(EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)
SqmEntityJoinback to summary
protected SqmEntityJoin(NavigablePath navigablePath, EntityDomainType<T> joinedEntityDescriptor, String alias, SqmJoinType joinType, SqmRoot<?> sqmRoot)

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
copyback to summary
public SqmEntityJoin<T> copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmJoin.copy, org.hibernate.query.sqm.tree.from.SqmFrom.copy, org.hibernate.query.sqm.tree.domain.SqmPath.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

Annotations
@Override
createCorrelationback to summary
public SqmCorrelatedEntityJoin<T> createCorrelation()

Implements abstract org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.createCorrelation.

Annotations
@Override
findRootback to summary
public SqmRoot<?> findRoot()

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.findRoot.

Annotations
@Override
getEntityNameback to summary
public String getEntityName()
getLhsback to summary
public SqmPath<?> getLhs()

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

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

Doc from org.hibernate.query.criteria.JpaPath.getLhs.

The source (think "left hand side") of this path

Annotations
@Override
getModelback to summary
public EntityDomainType<T> getModel()

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

Implements org.hibernate.query.criteria.JpaEntityJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Doc from jakarta.persistence.criteria.Path.getModel.

Return the bindable object that corresponds to the path expression.

Returns:EntityDomainType<T>

bindable object corresponding to the path

Annotations
@Override
getReferencedPathSourceback to summary
public EntityDomainType<T> getReferencedPathSource()

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

Implements org.hibernate.query.sqm.tree.from.SqmFrom.getReferencedPathSource, org.hibernate.query.sqm.tree.domain.SqmPath.getReferencedPathSource.

Doc from org.hibernate.query.sqm.tree.from.SqmFrom.getReferencedPathSource.

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).

Annotations
@Override
getRootback to summary
public SqmRoot<?> getRoot()
isImplicitlySelectableback to summary
public boolean isImplicitlySelectable()

Implements org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

Doc from org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

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

Annotations
@Override
makeCopyback to summary
public SqmEntityJoin<T> makeCopy(SqmCreationProcessingState creationProcessingState)
onback to summary
public SqmEntityJoin<T> on(JpaExpression<Boolean> restriction)

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

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

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

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

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

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

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

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

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

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

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

Annotations
@Override
resolveIndexedAccessback to summary
public SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.resolveIndexedAccess.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmTreatedEntityJoin<T, S> treatAs(Class<S> treatJavaType) throws PathException

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmTreatedEntityJoin<T, S> treatAs(EntityDomainType<S> treatTarget) throws PathException

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmFrom<?, S> treatAs(Class<S> treatJavaType, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmFrom<?, S> treatAs(EntityDomainType<S> treatTarget, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Annotations
@Override