org.eclipse.persistence.internal.jpa.metadata.accessors.classes

Class EmbeddableAccessor

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.classes.EmbeddableAccessor

public class EmbeddableAccessor
extends ClassAccessor

INTERNAL: An embeddable accessor. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be handled in the merge method. (merging is done at the accessor/mapping level) - any metadata mapped from XML to this class must be initialized in the initXMLObject method. - methods should be preserved in alphabetical order.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

Constructor Summary

Constructors

Constructor and Description
EmbeddableAccessor() INTERNAL:
EmbeddableAccessor(MetadataAnnotation annotation, MetadataClass cls, MetadataProject project) INTERNAL:

Method Summary

Modifier and Type	Method and Description
void	addEmbeddingAccessors(java.util.Map<java.lang.String,ClassAccessor> embeddingAccessors) INTERNAL:
void	addOwningDescriptor(MetadataDescriptor owningDescriptor) INTERNAL:
void	addOwningDescriptors(java.util.List<MetadataDescriptor> owningDescriptors) INTERNAL:
java.util.Map<java.lang.String,ClassAccessor>	getEmbeddingAccessors() INTERNAL:
MetadataDescriptor	getOwningDescriptor() INTERNAL: So, here's the deal ...
boolean	isEmbeddableAccessor() INTERNAL: Return true if this accessor represents an embeddable accessor.
void	preProcess() INTERNAL: The pre-process method is called during regular deployment and metadata processing.
void	preProcessForCanonicalModel() INTERNAL: The pre-process for canonical model method is called (and only called) during the canonical model generation.
void	process() INTERNAL: Process the metadata from this embeddable class.
void	processAccessMethods() INTERNAL: For VIRTUAL access we need to look for default access methods that we need to use with our mapping attributes.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor

addAccessors, clearPreProcessed, equals, excludeDefaultMappings, getAccessType, getAssociationOverrides, getAttributeOverrides, getAttributes, getChangeTracking, getClassName, getCloneCopyPolicy, getCopyPolicy, getCustomCopyPolicy, getCustomizerClass, getCustomizerClassName, getDescription, getExcludeDefaultMappings, getIdentifier, getInstantiationCopyPolicy, getJavaClass, getJavaClassName, getMappedSuperclasses, getMetadataComplete, getNoSql, getOracleArrayTypes, getOracleObjectTypes, getOwningDescriptors, getParentClassName, getPLSQLRecords, getPLSQLTables, getStruct, hasDerivedId, ignoreAnnotations, initXMLClassAccessor, initXMLObject, isAnnotationPresent, isClassAccessor, isEntityAccessor, isMappedSuperclass, isMetadataComplete, isPreProcessed, isProcessed, merge, processComplexMetadataTypes, processDerivedId, processMappingAccessors, processParentClass, setAssociationOverrides, setAttributeOverrides, setAttributes, setChangeTracking, setClassName, setCloneCopyPolicy, setCustomCopyPolicy, setCustomizerClassName, setDescription, setExcludeDefaultMappings, setInstantiationCopyPolicy, setJavaClass, setMetadataComplete, setNoSql, setOracleArrayTypes, setOracleObjectTypes, setParentClassName, setPLSQLRecords, setPLSQLTables, setStruct, toString, usesFieldAccess, usesPropertyAccess, usesVirtualAccess

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getAttributeName, getConverters, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, processConverters, processPartitioned, setAccess, setAccessMethods, setConverters, setDescriptor, setHashPartitioning, setName, setObjectTypeConverters, setPartitioned, setPartitioning, setPinnedPartitioning, setProperties, setRangePartitioning, setReplicationPartitioning, setRoundRobinPartitioning, setSerializedConverters, setStructConverters, setTypeConverters, setUnionPartitioning, setValuePartitioning

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EmbeddableAccessor

public EmbeddableAccessor()

INTERNAL:

EmbeddableAccessor

public EmbeddableAccessor(MetadataAnnotation annotation,
                          MetadataClass cls,
                          MetadataProject project)

INTERNAL:

Method Detail

addEmbeddingAccessors

public void addEmbeddingAccessors(java.util.Map<java.lang.String,ClassAccessor> embeddingAccessors)

INTERNAL:

addOwningDescriptor

public void addOwningDescriptor(MetadataDescriptor owningDescriptor)

INTERNAL:

addOwningDescriptors

public void addOwningDescriptors(java.util.List<MetadataDescriptor> owningDescriptors)

INTERNAL:

getEmbeddingAccessors

public java.util.Map<java.lang.String,ClassAccessor> getEmbeddingAccessors()

INTERNAL:

getOwningDescriptor

public MetadataDescriptor getOwningDescriptor()

INTERNAL: So, here's the deal ... this method typically gets called when defaulting pk's name, primary table names etc. for various mappings. The problem however is that we go beyond the spec and allow more mappings to be specified on embeddable classes. For example, a M-M would default its join table and join columns using the info from its owning descriptor. The problem then is ... what to do when this embedabble has multiple owning descriptors? That is, is shared. Right now, their pk names from the owners better be same or mappings must be fully specified and not use any defaults. I think that is somewhat ok given we're going beyond the spec and TopLink doesn't even support it anyway??? So the stance is, we'll allow the extra mappings on embeddables that are not shared, however on shared cases there are restrictions. Users should use mapped superclasses when they have a need to share complex embeddables. Or they can write customizers to modify their embeddable descriptors after initialize (after they have been cloned) Future: the metadata processing 'could' set all necessary (per owning descriptor) metadata and have the descriptor initialize code handle it. Metadata processing would process embeddable classes as it currently does for MappedSuperclasses. Clone them and process under each owning entity context. At descriptor initialize time, we would avoid cloning the aggregate descriptor and use the one metadata processing provided. Investigate further at a later date ... Callers to this method are ... BasicCollectionAccessor - processCollectionTable - defaults pk names from the owning descriptor. RelationshipAccessor - processJoinTable - defaults the join table name and the source field name OneToManyAccessor - processUnidirectionalOneToManyMapping - defaults the pk field and table. MappingAccessor - processAssociationOverride and updatePrimaryKeyField. ObjectAccessor - processId

Overrides:

getOwningDescriptor in class ClassAccessor

See Also:

EmbeddableAccessor

isEmbeddableAccessor

public boolean isEmbeddableAccessor()

INTERNAL: Return true if this accessor represents an embeddable accessor.

Overrides:

isEmbeddableAccessor in class ClassAccessor

preProcess

public void preProcess()

INTERNAL: The pre-process method is called during regular deployment and metadata processing. This method is called after each entity of the persistence unit has had an opportunity to pre-process itself first since we'll rely on owning entities for things like access type etc. The pre-process will run some validation. The order of processing is important, care must be taken if changes must be made.

Overrides:

preProcess in class ClassAccessor

preProcessForCanonicalModel

public void preProcessForCanonicalModel()

INTERNAL: The pre-process for canonical model method is called (and only called) during the canonical model generation. The use of this pre-process allows us to remove some items from the regular pre-process that do not apply to the canonical model generation. The order of processing is important, care must be taken if changes must be made.

Overrides:

preProcessForCanonicalModel in class ClassAccessor

process

public void process()

INTERNAL: Process the metadata from this embeddable class.

Overrides:

process in class ClassAccessor

processAccessMethods

public void processAccessMethods()

INTERNAL: For VIRTUAL access we need to look for default access methods that we need to use with our mapping attributes.