Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metamodel

Class MapAttributeImpl<X,K,V>

java.lang.Object

org.eclipse.persistence.internal.jpa.metamodel.AttributeImpl<X,Map<K,V>>

org.eclipse.persistence.internal.jpa.metamodel.PluralAttributeImpl<X,Map<K,V>,V>

org.eclipse.persistence.internal.jpa.metamodel.MapAttributeImpl<X,K,V>

Type Parameters:

X - The type the represented Map belongs to

K - The type of the key of the represented Map

V - The type of the value of the represented Map

All Implemented Interfaces:

Attribute<X,Map<K,V>>, Bindable<V>, MapAttribute<X,K,V>, PluralAttribute<X,Map<K,V>,V>, Serializable

public class MapAttributeImpl<X,K,V>
extends PluralAttributeImpl<X,Map<K,V>,V>
implements MapAttribute<X,K,V>

Purpose: Provides the implementation for the MapAttribute interface of the JPA 2.0 Metamodel API (part of the JSR-317 EJB 3.1 Criteria API)

Description: Instances of the type MapAttribute represent persistent Map-valued attributes.

Since:

EclipseLink 1.2 - JPA 2.0

See Also:

• MapAttribute
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Attribute

Attribute.PersistentAttributeType

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Bindable

Bindable.BindableType

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.PluralAttribute

PluralAttribute.CollectionType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapAttributeImpl(ManagedTypeImpl<X> managedType, CollectionMapping mapping)	INTERNAL:
protected	MapAttributeImpl(ManagedTypeImpl<X> managedType, CollectionMapping mapping, boolean validationEnabled)	INTERNAL: Create a new MapAttribute instance.

Method Summary

Modifier and Type	Method	Description
PluralAttribute.CollectionType	getCollectionType()	Return the collection type.
Class	getJavaType()	Return the Java type of the represented attribute.
Class<K>	getKeyJavaType()	Return the Java type of the map key.
Type<K>	getKeyType()	Return the type representing the key type of the map.

Methods inherited from class org.eclipse.persistence.internal.jpa.metamodel.PluralAttributeImpl

getBindableJavaType, getBindableType, getCollectionMapping, getElementType, isPlural, toString

Methods inherited from class org.eclipse.persistence.internal.jpa.metamodel.AttributeImpl

getDeclaringType, getDescriptor, getJavaMember, getManagedTypeImpl, getMapping, getMetamodel, getName, getPersistentAttributeType, isAssociation, isCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.persistence.metamodel.Attribute

getDeclaringType, getJavaMember, getName, getPersistentAttributeType, isAssociation, isCollection

Methods inherited from interface jakarta.persistence.metamodel.Bindable

getBindableJavaType, getBindableType

Methods inherited from interface jakarta.persistence.metamodel.PluralAttribute

getElementType

Constructor Details

MapAttributeImpl

protected MapAttributeImpl(ManagedTypeImpl<X> managedType,
 CollectionMapping mapping)

INTERNAL:

MapAttributeImpl

protected MapAttributeImpl(ManagedTypeImpl<X> managedType,
 CollectionMapping mapping,
 boolean validationEnabled)

INTERNAL: Create a new MapAttribute instance. The elementType field is instantiated in the superclass. The keyType field is instantiated in this constructor by using one of the following A) MapContainerPolicy by consulting the keyField or PK class B) MappedKeyMapContainerPolicy by using the mapKeyTargetType on the keyMapping or the attributeClassification on the attributeAccessor

Parameters:

managedType - - the owning type (EmbeddableTypes do not support mappings)

mapping - - contains the mapping policy

validationEnabled - - report errors in the metamodel

Method Details

getCollectionType

public PluralAttribute.CollectionType getCollectionType()

Return the collection type.

Specified by:

getCollectionType in interface PluralAttribute<X,K,V>

Specified by:

getCollectionType in class PluralAttributeImpl<X,Map<K,V>,V>

Returns:

collection type

getJavaType

public Class getJavaType()

Return the Java type of the represented attribute.

Specified by:

getJavaType in interface Attribute<X,K>

Specified by:

getJavaType in class AttributeImpl<X,Map<K,V>>

Returns:

Java type

getKeyJavaType

public Class<K> getKeyJavaType()

Return the Java type of the map key.

Specified by:

getKeyJavaType in interface MapAttribute<X,K,V>

Returns:

Java key type

See Also:

• MapAttribute

getKeyType

public Type<K> getKeyType()

Return the type representing the key type of the map.

Specified by:

getKeyType in interface MapAttribute<X,K,V>

Returns:

type representing key type

See Also:

• MapAttribute