EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

javax.persistence.criteria
Interface ListJoin<Z,E>

Type Parameters:
Z - the source type of the join
E - the element type of the target List
All Superinterfaces:
Expression<E>, FetchParent<Z,E>, From<Z,E>, Join<Z,E>, Path<E>, PluralJoin<Z,java.util.List<E>,E>, Selection<E>, TupleElement<E>

public interface ListJoin<Z,E>
extends PluralJoin<Z,java.util.List<E>,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:
Java Persistence 2.0

Method Summary
 ListAttribute<? super Z,E> getModel()
          Return the metamodel representation for the list attribute.
 Expression<java.lang.Integer> index()
          Create an expression that corresponds to the index of the object in the referenced association or element collection.
 
Methods inherited from interface javax.persistence.criteria.Join
getAttribute, getJoinType, getParent
 
Methods inherited from interface javax.persistence.criteria.From
getCorrelationParent, getJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet
 
Methods inherited from interface javax.persistence.criteria.Path
get, get, get, get, getParentPath, type
 
Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull
 
Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
 
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
 
Methods inherited from interface javax.persistence.criteria.FetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
 

Method Detail

getModel

ListAttribute<? super Z,E> getModel()
Return the metamodel representation for the list attribute.

Specified by:
getModel in interface Path<E>
Specified by:
getModel in interface PluralJoin<Z,java.util.List<E>,E>
Returns:
metamodel type representing the List that is the target of the join

index

Expression<java.lang.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.

Returns:
expression denoting the index

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference