Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.querydef

public Class JoinImpl<Z, X>

extends FromImpl<Z, X>
implements Join<Z, X>, Fetch<Z, X>
Class Inheritance
All Implemented Interfaces
jakarta.persistence.criteria.Fetch, jakarta.persistence.criteria.FetchParent, jakarta.persistence.criteria.Join, jakarta.persistence.criteria.From, jakarta.persistence.criteria.Path, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.querydef.ListJoinImpl, org.eclipse.persistence.internal.jpa.querydef.MapJoinImpl, org.eclipse.persistence.internal.jpa.querydef.SetJoinImpl, org.eclipse.persistence.internal.jpa.querydef.CollectionJoinImpl
Imports
java.util.ArrayList, .List, jakarta.persistence.criteria.Expression, .Fetch, .From, .Join, .JoinType, .Path, .Predicate, .Predicate.BooleanOperator, jakarta.persistence.metamodel.Attribute, .Bindable, .ManagedType, .Metamodel

Purpose: Contains the implementation of the Join interface of the JPA criteria API.

Description: This class represents a join of an attribute from a "From"element.

Author
gyorke
Since
EclipseLink 1.2
See Also
Join

Field Summary

Modifier and TypeField and Description
protected JoinType
joinType

protected Expression<Boolean>
on

Inherited from org.eclipse.persistence.internal.jpa.querydef.FromImpl:
correlatedParentfetchesisFetchisJoinjoinsmanagedType

Constructor Summary

AccessConstructor and Description
public <T>
JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact)

public <T>
JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)

public <T>
JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType, FromImpl<Z, X> correlatedParent)

Method Summary

Modifier and TypeMethod and Description
protected <T> Expression<T>
buildExpressionForAs(Class<T> type)

Overrides org.eclipse.persistence.internal.jpa.querydef.ExpressionImpl.buildExpressionForAs.

public Attribute<? super Z, ?>

Returns:

metamodel Attribute type for the join
getAttribute()

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

Return the metamodel Attribute corresponding to the join.
public JoinType

Returns:

join type
getJoinType()

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

Return the join type.
public Predicate
getOn()

Implements jakarta.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>

Returns:

join parent
getParent()

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

Return the parent of the join.
public JoinImpl<Z, X>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Implements jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public JoinImpl<Z, X>
on(Predicate...
zero or more restriction predicates
restrictions)

Implements jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
Inherited from org.eclipse.persistence.internal.jpa.querydef.FromImpl:
fetchfetchfetchfetchfetchfetchfindJoinFetchesfindJoinsgetgetgetgetgetCorrelationParentgetFetchesgetJoinsisCorrelatedisFromjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinCollectionjoinCollectionjoinListjoinListjoinMapjoinMapjoinSetjoinSettype

Field Detail

joinTypeback to summary
protected JoinType joinType
onback to summary
protected Expression<Boolean> on

Constructor Detail

JoinImplback to summary
public <T> JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact)
JoinImplback to summary
public <T> JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)
JoinImplback to summary
public <T> JoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType, FromImpl<Z, X> correlatedParent)

Method Detail

buildExpressionForAsback to summary
protected <T> Expression<T> buildExpressionForAs(Class<T> type)

Overrides org.eclipse.persistence.internal.jpa.querydef.ExpressionImpl.buildExpressionForAs.

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

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

Return the metamodel Attribute corresponding to the join.

Returns:Attribute<? super Z, ?>

metamodel Attribute type for the join

Annotations
@Override
getJoinTypeback to summary
public JoinType getJoinType()

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

Return the join type.

Returns:JoinType

join type

Annotations
@Override
getOnback to summary
public Predicate getOn()

Implements jakarta.persistence.criteria.Join.getOn.

Doc from jakarta.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()

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

Return the parent of the join.

Returns:From<?, Z>

join parent

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

Implements jakarta.persistence.criteria.Join.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:JoinImpl<Z, X>

the modified join object

Annotations
@Override
onback to summary
public JoinImpl<Z, X> on(Predicate... restrictions)

Implements jakarta.persistence.criteria.Join.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:JoinImpl<Z, X>

the modified join object

Annotations
@Override