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

public Class ListJoinImpl<Z, X>

extends JoinImpl<Z, X>
implements ListJoin<Z, X>
Class Inheritance
All Implemented Interfaces
jakarta.persistence.criteria.ListJoin, jakarta.persistence.criteria.PluralJoin, 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
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.querydef.BasicListJoinImpl
Imports
jakarta.persistence.criteria.Expression, .JoinType, .ListJoin, .Path, .Predicate, jakarta.persistence.metamodel.Bindable, .ManagedType, .Metamodel, org.eclipse.persistence.internal.helper.ClassConstants

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
ListJoin

Field Summary

Inherited from org.eclipse.persistence.internal.jpa.querydef.JoinImpl:
joinTypeon

Constructor Summary

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

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

public <T>
ListJoinImpl(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
public ListAttribute<? super Z, X>

Returns:

metamodel type representing the Collection that is the target of the join
getModel
()

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.getModel.

Implements jakarta.persistence.criteria.ListJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Return the metamodel representation for the collection.
public Expression<Integer>
index()

Implements jakarta.persistence.criteria.ListJoin.index.

Create an expression that corresponds to the index of the object in the referenced association or element collection.
public ListJoinImpl<Z, X>
on(Expression<Boolean>
a simple or compound boolean expression
restriction
)

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.ListJoin.on, jakarta.persistence.criteria.Join.on.

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

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.ListJoin.on, 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.JoinImpl:
buildExpressionForAsgetAttributegetJoinTypegetOngetParent

Constructor Detail

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

Method Detail

getModelback to summary
public ListAttribute<? super Z, X> getModel()

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.getModel.

Implements jakarta.persistence.criteria.ListJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Return the metamodel representation for the collection.

Returns:ListAttribute<? super Z, X>

metamodel type representing the Collection that is the target of the join

Annotations
@Override
indexback to summary
public Expression<Integer> index()

Implements jakarta.persistence.criteria.ListJoin.index.

Doc from jakarta.persistence.criteria.ListJoin.index.

Create an expression that corresponds to the index of the object in the referenced association or element collection. This method must only be invoked upon an object that represents an association or element collection for which an order column has been defined.

Returns:Expression<Integer>

expression denoting the index

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

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.ListJoin.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.ListJoin.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:ListJoinImpl<Z, X>

the modified join object

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

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.ListJoin.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.ListJoin.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:ListJoinImpl<Z, X>

the modified join object

Annotations
@Override