JPA Interface

MapJoin

Type Parameters:
<Z> - the source type of the join
<K> - the type of the target Map key
<V> - the type of the target Map value
Super Interfaces:
Expression<V>, FetchParent<Z,V>, From<Z,V>, Join<Z,V>, Path<V>, PluralJoin<Z,Map<K,V>,V>, Selection<V>, TupleElement<V>
The MapJoin 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.Map.
Since:
JPA 2.0

Public Methods

Expression<Entry<K,V>> entry()
Create an expression that corresponds to the map entry.
Return:
expression corresponding to the map entry
Since:
JPA 2.0
MapAttribute<?superZ,K,V> getModel()
Return the metamodel representation for the map attribute.
Return:
metamodel type representing the {@code Map} that is the target of the join
Since:
JPA 2.0
Path<K> key()
Create a path expression that corresponds to the map key.
Return:
path corresponding to map key
Since:
JPA 2.0
MapJoin<Z,K,V> 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
MapJoin<Z,K,V> 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
Path<V> value()
Create a path expression that corresponds to the map value.
This method is for stylistic use only: it just returns this.
Return:
path corresponding to the map value
Since:
JPA 2.0