Package javax.persistence.criteria
Interface ListJoin<Z,E>
- Type Parameters:
Z
- the source type of the joinE
- the element type of the target List
- All Superinterfaces:
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:
- Java Persistence 2.0
-
Method Summary
Modifier and TypeMethodDescriptionListAttribute<? super Z,
E> getModel()
Return the metamodel representation for the list attribute.index()
Create an expression that corresponds to the index of the object in the referenced association or element collection.on
(Expression<Boolean> restriction) Modify the join to restrict the result according to the specified ON condition and return the join object.Modify the join to restrict the result according to the specified ON condition and return the join object.Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull
Methods inherited from interface javax.persistence.criteria.FetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
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.Join
getAttribute, getJoinType, getOn, getParent
Methods inherited from interface javax.persistence.criteria.Path
get, get, get, get, getParentPath, type
Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
-
Method Details
-
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. -
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. -
getModel
ListAttribute<? super Z,E> getModel()Return the metamodel representation for the list attribute. -
index
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.- Returns:
- expression denoting the index
-