org.eclipse.persistence.internal.jpa.metadata.columns

Class OverrideMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.columns.OverrideMetadata

Direct Known Subclasses:

AssociationOverrideMetadata, AttributeOverrideMetadata

public abstract class OverrideMetadata
extends ORMetadata

INTERNAL: Object to hold onto common attribute/association override metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OverrideMetadata(MetadataAnnotation annotation, MetadataAccessor accessor) INTERNAL: Used for annotation loading.
protected	OverrideMetadata(String xmlElement) INTERNAL: Used for XML loading.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) INTERNAL:
String	getIdentifier() INTERNAL: To satisfy the MetadataMergeable interface for subclasses and provide a means of uniquely identifying objects.
abstract String	getIgnoreMappedSuperclassContext() INTERNAL:
String	getName() INTERNAL: Used for OX mapping.
int	hashCode()
void	setName(String name) INTERNAL: Used for OX mapping.
boolean	shouldOverride(OverrideMetadata existing, MetadataLogger logger, String descriptorClass) INTERNAL: Method to determine if this ORMetadata should override another.

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverrideMetadata

protected OverrideMetadata(MetadataAnnotation annotation,
                           MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

OverrideMetadata

protected OverrideMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getIdentifier

public String getIdentifier()

INTERNAL: To satisfy the MetadataMergeable interface for subclasses and provide a means of uniquely identifying objects.

Overrides:

getIdentifier in class ORMetadata

See Also:

ORMetadata.shouldOverride(ORMetadata), ORMetadata.mergeORObjects(ORMetadata, ORMetadata), ORMetadata.mergeORObjectLists(List, List)

getIgnoreMappedSuperclassContext

public abstract String getIgnoreMappedSuperclassContext()

INTERNAL:

getName

public String getName()

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

shouldOverride

public boolean shouldOverride(OverrideMetadata existing,
                              MetadataLogger logger,
                              String descriptorClass)

INTERNAL: Method to determine if this ORMetadata should override another. Assumes all ORMetadata have correctly implemented their equals method and will return their correct logging context for any ignore messages. This is called on class level override metadata (and not those from an embedded mapping).