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

Class ConverterAccessor

java.lang.Object

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

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

public class ConverterAccessor
extends ORMetadata

Object to represent a converter class. 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 2.5

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field	Description
protected MetadataClass	attributeClassification
protected java.lang.Boolean	autoApply
protected java.lang.String	className
protected MetadataClass	fieldClassification

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

m_project

Constructor Summary

Constructors

Constructor	Description
ConverterAccessor()	INTERNAL: Used for XML loading.
ConverterAccessor(MetadataAnnotation converter, MetadataClass metadataClass, MetadataProject project)	INTERNAL:

Method Summary

Modifier and Type	Method	Description
boolean	autoApply()	INTERNAL: Return true if this converter should auto apply
boolean	equals(java.lang.Object objectToCompare)	INTERNAL: Used for metadata merging.
MetadataClass	getAttributeClassification()	INTERNAL: Return the type this converter will auto apply to.
java.lang.Boolean	getAutoApply()	INTERNAL: Used for OX mapping.
java.lang.String	getClassName()	INTERNAL: Used for OX mapping.
java.lang.String	getIdentifier()	INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
java.lang.String	getJavaClassName()	INTERNAL:
int	hashCode()
protected void	initClassificationClasses(MetadataClass cls)	INTERNAL: Do some validation and initialize the attribute converter classficiation classes.
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL: Any subclass that cares to do any more initialization (e.g.
void	merge(ORMetadata metadata)	INTERNAL: Entity level merging details.
void	process(org.eclipse.persistence.mappings.DatabaseMapping mapping, boolean isForMapKey, java.lang.String attributeName)	INTERNAL: Process this converter for the given mapping.
void	process(org.eclipse.persistence.mappings.DatabaseMapping mapping, boolean isForMapKey, java.lang.String attributeName, boolean disableConversion)	INTERNAL: Process this converter for the given mapping.
void	setAutoApply(java.lang.Boolean autoApply)	INTERNAL: Used for OX mapping.
void	setClassName(java.lang.String className)	INTERNAL: Used for OX mapping.

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, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, 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

Field Detail

className

protected java.lang.String className

autoApply

protected java.lang.Boolean autoApply

attributeClassification

protected MetadataClass attributeClassification

fieldClassification

protected MetadataClass fieldClassification

Constructor Detail

ConverterAccessor

public ConverterAccessor()

INTERNAL: Used for XML loading.

ConverterAccessor

public ConverterAccessor(MetadataAnnotation converter,
                         MetadataClass metadataClass,
                         MetadataProject project)

INTERNAL:

Method Detail

autoApply

public boolean autoApply()

INTERNAL: Return true if this converter should auto apply

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL: Used for metadata merging.

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAutoApply

public java.lang.Boolean getAutoApply()

INTERNAL: Used for OX mapping.

getAttributeClassification

public MetadataClass getAttributeClassification()

INTERNAL: Return the type this converter will auto apply to.

getClassName

public java.lang.String getClassName()

INTERNAL: Used for OX mapping.

getIdentifier

public java.lang.String getIdentifier()

INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.

Overrides:

getIdentifier in class ORMetadata

See Also:

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

getJavaClassName

public java.lang.String getJavaClassName()

INTERNAL:

initClassificationClasses

protected void initClassificationClasses(MetadataClass cls)

INTERNAL: Do some validation and initialize the attribute converter classficiation classes.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL: Any subclass that cares to do any more initialization (e.g. initialize a class) should override this method.

Overrides:

initXMLObject in class ORMetadata

merge

public void merge(ORMetadata metadata)

INTERNAL: Entity level merging details.

Overrides:

merge in class ORMetadata

process

public void process(org.eclipse.persistence.mappings.DatabaseMapping mapping,
                    boolean isForMapKey,
                    java.lang.String attributeName)

INTERNAL: Process this converter for the given mapping.

process

public void process(org.eclipse.persistence.mappings.DatabaseMapping mapping,
                    boolean isForMapKey,
                    java.lang.String attributeName,
                    boolean disableConversion)

INTERNAL: Process this converter for the given mapping.

setAutoApply

public void setAutoApply(java.lang.Boolean autoApply)

INTERNAL: Used for OX mapping.

setClassName

public void setClassName(java.lang.String className)

INTERNAL: Used for OX mapping.