JPA Interface

CollectionJoin

Type Parameters:
<Z> - the source type of the join
<E> - the element type of the target {@code Collection}
Super Interfaces:
Expression<E>, FetchParent<Z,E>, From<Z,E>, Join<Z,E>, Path<E>, PluralJoin<Z,Collection<E>,E>, Selection<E>, TupleElement<E>
The CollectionJoin 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.Collection.
Since:
JPA 2.0

Public Methods

CollectionAttribute<?superZ,E> getModel()
Return the metamodel representation for the collection attribute.
Return:
metamodel type representing the {@code Collection} that is the target of the join
Since:
JPA 2.0
CollectionJoin<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
CollectionJoin<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