Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.querydef

public Class MapJoinImpl<Z, K, V>

extends JoinImpl<Z, V>
implements MapJoin<Z, K, V>
Class Inheritance
All Implemented Interfaces
jakarta.persistence.criteria.MapJoin, jakarta.persistence.criteria.PluralJoin, jakarta.persistence.criteria.Join, jakarta.persistence.criteria.From, jakarta.persistence.criteria.FetchParent, jakarta.persistence.criteria.Path, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.querydef.BasicMapJoinImpl
Imports
java.util.Map, jakarta.persistence.criteria.Expression, .Join, .JoinType, .MapJoin, .Path, .Predicate, jakarta.persistence.metamodel.Bindable, .ManagedType, .MapAttribute, .Metamodel, .Type.PersistenceType, org.eclipse.persistence.internal.helper.ClassConstants, org.eclipse.persistence.internal.localization.ExceptionLocalization

Purpose: Contains the implementation of the Join interface of the JPA criteria API.

Description: This class represents a join of an attribute from a "From"element.

Author
gyorke
Since
EclipseLink 1.2
See Also
MapJoin

Field Summary

Inherited from org.eclipse.persistence.internal.jpa.querydef.JoinImpl:
joinTypeon

Constructor Summary

AccessConstructor and Description
public <T>
MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact)

public <T>
MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)

public <T>
MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType, FromImpl<Z, X> correlatedParent)

Method Summary

Modifier and TypeMethod and Description
public Expression<Map.Entry<K, V>>
entry()

Implements jakarta.persistence.criteria.MapJoin.entry.

Create an expression that corresponds to the map entry.
public MapAttribute<? super Z, K, V>

Returns:

metamodel type representing the Collection that is the target of the join
getModel()

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.getModel.

Implements jakarta.persistence.criteria.MapJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Return the metamodel representation for the collection.
public Join<Map<K, V>, K>
joinKey()

public Join<Map<K, V>, K>
joinKey(JoinType jt)

public Path<K>
key()

Implements jakarta.persistence.criteria.MapJoin.key.

Create a path expression that corresponds to the map key.
public MapJoinImpl<Z, K, V>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.MapJoin.on, jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public MapJoinImpl<Z, K, V>
on(Predicate...
zero or more restriction predicates
restrictions)

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.MapJoin.on, jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public Path<V>
value()

Implements jakarta.persistence.criteria.MapJoin.value.

Create a path expression that corresponds to the map value.
Inherited from org.eclipse.persistence.internal.jpa.querydef.JoinImpl:
buildExpressionForAsgetAttributegetJoinTypegetOngetParent

Constructor Detail

MapJoinImplback to summary
public <T> MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact)
MapJoinImplback to summary
public <T> MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)
MapJoinImplback to summary
public <T> MapJoinImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<V> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType, FromImpl<Z, X> correlatedParent)

Method Detail

entryback to summary
public Expression<Map.Entry<K, V>> entry()

Implements jakarta.persistence.criteria.MapJoin.entry.

Doc from jakarta.persistence.criteria.MapJoin.entry.

Create an expression that corresponds to the map entry.

Returns:Expression<Map.Entry<K, V>>

expression corresponding to the map entry

Annotations
@Override
getModelback to summary
public MapAttribute<? super Z, K, V> getModel()

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.getModel.

Implements jakarta.persistence.criteria.MapJoin.getModel, jakarta.persistence.criteria.Path.getModel.

Return the metamodel representation for the collection.

Returns:MapAttribute<? super Z, K, V>

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

Annotations
@Override
joinKeyback to summary
public Join<Map<K, V>, K> joinKey()
joinKeyback to summary
public Join<Map<K, V>, K> joinKey(JoinType jt)
keyback to summary
public Path<K> key()

Implements jakarta.persistence.criteria.MapJoin.key.

Doc from jakarta.persistence.criteria.MapJoin.key.

Create a path expression that corresponds to the map key.

Returns:Path<K>

path corresponding to map key

Annotations
@Override
onback to summary
public MapJoinImpl<Z, K, V> on(Expression<Boolean> restriction)

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.MapJoin.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.MapJoin.on.

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:Expression<Boolean>

a simple or compound boolean expression

Returns:MapJoinImpl<Z, K, V>

the modified join object

Annotations
@Override
onback to summary
public MapJoinImpl<Z, K, V> on(Predicate... restrictions)

Overrides org.eclipse.persistence.internal.jpa.querydef.JoinImpl.on.

Implements jakarta.persistence.criteria.MapJoin.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.MapJoin.on.

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:Predicate[]

zero or more restriction predicates

Returns:MapJoinImpl<Z, K, V>

the modified join object

Annotations
@Override
valueback to summary
public Path<V> value()

Implements jakarta.persistence.criteria.MapJoin.value.

Doc from jakarta.persistence.criteria.MapJoin.value.

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

Returns:Path<V>

path corresponding to the map value

Annotations
@Override