-
- 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>
public interface ListJoin<Z,E> extends PluralJoin<Z,List<E>,E>
TheListJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as ajava.util.List
.- Since:
- Java Persistence 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ListAttribute<? super Z,E>
getModel()
Return the metamodel representation for the list attribute.Expression<Integer>
index()
Create an expression that corresponds to the index of the object in the referenced association or element collection.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.ListJoin<Z,E>
on(Predicate... restrictions)
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.Join
getAttribute, getJoinType, getOn, 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
-
-
-
-
Method Detail
-
on
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.
-
on
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.
-
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
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/criteria/listjoin.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.