JPA Interface

ListJoin

Type Parameters:
<Z> - the source type of the join
<E> - the element type of the target List
Super Interfaces:
Expression<E>, FetchParent<Z,E>, From<Z,E>, Join<Z,E>, Path<E>, PluralJoin<Z,List<E>,E>, Selection<E>, TupleElement<E>
The ListJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a java.util.List.
Since:
JPA 2.0

Public Methods

ListAttribute<?superZ,E> getModel()
Return the metamodel representation for the list attribute.
Return:
metamodel type representing the {@code List} that is the target of the join
Since:
JPA 2.0
Expression<Integer> 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.
Return:
expression denoting the index
Since:
JPA 2.0
ListJoin<Z,E> on(Expression<Boolean> restriction)
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 - a simple or compound boolean expression
Return:
the modified join object
Since:
JPA 2.1
ListJoin<Z,E> on(Predicate... restrictions)
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 - zero or more restriction predicates
Return:
the modified join object
Since:
JPA 2.1