Top Description Fields Constructors Methods
org.hibernate.query.criteria.internal.path

public abstract Class AbstractJoinImpl<Z, X>

extends AbstractFromImpl<Z, X>
implements JoinImplementor<Z, X>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.query.criteria.internal.JoinImplementor, org.hibernate.query.criteria.internal.FromImplementor, javax.persistence.criteria.From, javax.persistence.criteria.FetchParent, javax.persistence.criteria.Path, javax.persistence.criteria.Expression, javax.persistence.criteria.Selection, javax.persistence.TupleElement, org.hibernate.query.criteria.internal.PathImplementor, org.hibernate.query.criteria.internal.Renderable, org.hibernate.query.criteria.internal.PathSource, org.hibernate.query.criteria.internal.ExpressionImplementor, org.hibernate.query.criteria.internal.SelectionImplementor, org.hibernate.query.criteria.internal.TupleElementImplementor, javax.persistence.criteria.Fetch, javax.persistence.criteria.Join
Known Direct Subclasses
org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport, org.hibernate.query.criteria.internal.path.SingularAttributeJoin
Imports
java.io.Serializable, javax.persistence.criteria.Expression, .From, .JoinType, .Predicate, javax.persistence.metamodel.Attribute, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .CriteriaSubqueryImpl, .FromImplementor, .JoinImplementor, .PathSource, org.hibernate.query.criteria.internal.compile.RenderingContext, org.hibernate.query.criteria.internal.predicate.PredicateImplementor
Convenience base class for various javax.persistence.criteria.Join implementations.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final Attribute<? super Z, ?>
joinAttribute

private final JoinType
joinType

private Predicate
suppliedJoinCondition

Inherited from org.hibernate.query.criteria.internal.path.AbstractFromImpl:
DEFAULT_JOIN_TYPE

Constructor Summary

AccessConstructor and Description
public
AbstractJoinImpl(CriteriaBuilderImpl criteriaBuilder, PathSource<Z> pathSource, Attribute<? super Z, X> joinAttribute, JoinType joinType)

public
AbstractJoinImpl(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource<Z> pathSource, Attribute<? super Z, ?> joinAttribute, JoinType joinType)

Method Summary

Modifier and TypeMethod and Description
public JoinImplementor<Z, X>
correlateTo(CriteriaSubqueryImpl<T> subquery)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.correlateTo.

Implements org.hibernate.query.criteria.internal.JoinImplementor.correlateTo, org.hibernate.query.criteria.internal.FromImplementor.correlateTo.

Refined return type
public Attribute<? super Z, ?>
getAttribute()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getAttribute.

Implements javax.persistence.criteria.Join.getAttribute, javax.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.internal.PathImplementor.getAttribute.

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

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

Return the join type.
public Predicate
getOn()

Implements javax.persistence.criteria.Join.getOn.

Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.
public From<?, Z>
getParent()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getParent.

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

Return the parent of the join.
public JoinImplementor<Z, X>
on(Predicate...
zero or more restriction predicates
restrictions)

Implements org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Predicate...) and Fetch#on(Predicate...)
public JoinImplementor<Z, X>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Implements org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Expression) and Fetch#on(Expression)
public String
renderTableExpression(RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.FromImplementor.renderTableExpression.

Inherited from org.hibernate.query.criteria.internal.path.AbstractFromImpl:
canBeDereferencedcanBeFetchSourcecanBeJoinSourcecanBeReplacedByCorrelatedParentInSubQuerycreateCorrelationDelegatefetchfetchfetchfetchfetchfetchgetAliasgetCorrelationParentgetFetchesgetJoinsgetPathIdentifiergetPathSourceillegalFetchillegalJoinisCorrelatedjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinCollectionjoinCollectionjoinListjoinListjoinMapjoinMapjoinSetjoinSetlocateAttributeInternallocateManagedTypeprepareAliasprepareCorrelationDelegaterender

Field Detail

joinAttributeback to summary
private final Attribute<? super Z, ?> joinAttribute
joinTypeback to summary
private final JoinType joinType
suppliedJoinConditionback to summary
private Predicate suppliedJoinCondition

Constructor Detail

AbstractJoinImplback to summary
public AbstractJoinImpl(CriteriaBuilderImpl criteriaBuilder, PathSource<Z> pathSource, Attribute<? super Z, X> joinAttribute, JoinType joinType)
AbstractJoinImplback to summary
public AbstractJoinImpl(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource<Z> pathSource, Attribute<? super Z, ?> joinAttribute, JoinType joinType)

Method Detail

correlateToback to summary
public JoinImplementor<Z, X> correlateTo(CriteriaSubqueryImpl<T> subquery)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.correlateTo.

Implements org.hibernate.query.criteria.internal.JoinImplementor.correlateTo, org.hibernate.query.criteria.internal.FromImplementor.correlateTo.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.correlateTo.

Refined return type

Annotations
@Override
getAttributeback to summary
public Attribute<? super Z, ?> getAttribute()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getAttribute.

Implements javax.persistence.criteria.Join.getAttribute, javax.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.internal.PathImplementor.getAttribute.

Doc from javax.persistence.criteria.Join.getAttribute.

Return the metamodel attribute corresponding to the join.

Returns:Attribute<? super Z, ?>

metamodel attribute corresponding to the join

Annotations
@Override
getJoinTypeback to summary
public JoinType getJoinType()

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

Doc from javax.persistence.criteria.Join.getJoinType.

Return the join type.

Returns:JoinType

join type

Annotations
@Override
getOnback to summary
public Predicate getOn()

Implements javax.persistence.criteria.Join.getOn.

Doc from javax.persistence.criteria.Join.getOn.

Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.

Returns:Predicate

the ON restriction predicate

Annotations
@Override
getParentback to summary
public From<?, Z> getParent()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getParent.

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

Doc from javax.persistence.criteria.Join.getParent.

Return the parent of the join.

Returns:From<?, Z>

join parent

Annotations
@Override
@SuppressWarnings:unchecked
onback to summary
public JoinImplementor<Z, X> on(Predicate... restrictions)

Implements org.hibernate.query.criteria.internal.JoinImplementor.on.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Predicate...) and Fetch#on(Predicate...)

Parameters
restrictions:Predicate[]

Doc from javax.persistence.criteria.Join.on.

zero or more restriction predicates

Returns:JoinImplementor<Z, X>

Doc from javax.persistence.criteria.Join.on.

the modified join object

Annotations
@Override
onback to summary
public JoinImplementor<Z, X> on(Expression<Boolean> restriction)

Implements org.hibernate.query.criteria.internal.JoinImplementor.on.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Expression) and Fetch#on(Expression)

Parameters
restriction:Expression<Boolean>

Doc from javax.persistence.criteria.Join.on.

a simple or compound boolean expression

Returns:JoinImplementor<Z, X>

Doc from javax.persistence.criteria.Join.on.

the modified join object

Annotations
@Override
renderTableExpressionback to summary
public String renderTableExpression(RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.FromImplementor.renderTableExpression.

Annotations
@Override