javax.persistence.criteria
Interface MapJoin<Z,K,V>

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

All Superinterfaces:

Expression<V>, FetchParent<Z,V>, From<Z,V>, Join<Z,V>, Path<V>, PluralJoin<Z,java.util.Map<K,V>,V>, Selection<V>, TupleElement<V>

public interface MapJoin<Z,K,V>
extends PluralJoin<Z,java.util.Map<K,V>,V>

The interface MapJoin 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:

java Persistence 2.0

Method Summary

Expression<java.util.Map.Entry<K,V>>	entry() Return an expression that corresponds to the map entry.
MapAttribute<? super Z,K,V>	getModel() Return the metamodel representation for the map.
Join<java.util.Map<K,V>,K>	joinKey() Specify an innerjoin over the map key.
Join<java.util.Map<K,V>,K>	joinKey(JoinType jt) Specify a join over the map key using the given join type.
Path<K>	key() Return a path expression that corresponds to the map key.
Path<V>	value() Return a path expression that corresponds to the map value.

Methods inherited from interface javax.persistence.criteria.Join

getAttribute, getJoinType, getParent

Methods inherited from interface javax.persistence.criteria.From

getJoins, 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

setAlias

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

MapAttribute<? super Z,K,V> getModel()

Return the metamodel representation for the map.

Specified by:

getModel in interface Path<V>

Specified by:

getModel in interface PluralJoin<Z,java.util.Map<K,V>,V>

Returns:

metamodel type representing the Map that is the target of the join

joinKey

Join<java.util.Map<K,V>,K> joinKey()

Specify an innerjoin over the map key.

Returns:

result of joining over the map key

joinKey

Join<java.util.Map<K,V>,K> joinKey(JoinType jt)

Specify a join over the map key using the given join type.

Parameters:

jt - join type

Returns:

result of joining over the map key

key

Path<K> key()

Return a path expression that corresponds to the map key.

Returns:

Path corresponding to map key

value

Path<V> value()

Return a path expression that corresponds to the map value. This method is for stylistic use only: it just returns this.

Returns:

Path corresponding to the map value

entry

Expression<java.util.Map.Entry<K,V>> entry()

Return an expression that corresponds to the map entry.

Returns:

Expression corresponding to the map entry