-
- Type Parameters:
Z
- the source type of the joinK
- the type of the target Map keyV
- 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>
TheMapJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as aMap
.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Expression<java.util.Map.Entry<K,V>>
entry()
Create an expression that corresponds to the map entry.MapAttribute<? super Z,K,V>
getModel()
Return the metamodel representation for the map attribute.Path<K>
key()
Create a path expression that corresponds to the map key.MapJoin<Z,K,V>
on(Expression<java.lang.Boolean> restriction)
Modify the join to restrict the result according to the specified ON condition and return the join object.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.Path<V>
value()
Create a path expression that corresponds to the map value.-
Methods inherited from interface jakarta.persistence.criteria.Expression
as, cast, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo
-
Methods inherited from interface jakarta.persistence.criteria.FetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
-
Methods inherited from interface jakarta.persistence.criteria.From
getCorrelationParent, getJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet
-
Methods inherited from interface jakarta.persistence.criteria.Join
getAttribute, getJoinType, getOn, getParent
-
Methods inherited from interface jakarta.persistence.criteria.Path
get, get, get, get, getParentPath, type
-
Methods inherited from interface jakarta.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
-
Methods inherited from interface jakarta.persistence.TupleElement
getAlias, getJavaType
-
-
-
-
Method Detail
-
on
MapJoin<Z,K,V> on(Expression<java.lang.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
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.
-
getModel
MapAttribute<? super Z,K,V> getModel()
Return the metamodel representation for the map attribute.
-
key
Path<K> key()
Create a path expression that corresponds to the map key.- Returns:
- path corresponding to map key
-
value
Path<V> value()
Create 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()
Create an expression that corresponds to the map entry.- Returns:
- expression corresponding to the map entry
-
-