Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.converters

public abstract Class MetadataConverter

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.converters.SerializedMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.TemporalMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.UUIDMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.XMLMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.AbstractConverterMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.ClassInstanceMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.EnumeratedMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.JSONMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.JsonValueMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.KryoMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.LobMetadata
Imports
org.eclipse.persistence.mappings.DatabaseMapping, .DirectCollectionMapping, .DirectMapMapping, org.eclipse.persistence.mappings.converters.Converter, org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping, .AbstractDirectMapping, org.eclipse.persistence.internal.jpa.metadata.ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, .MetadataClass

INTERNAL: Abstract converter class that parents both the JPA and Eclipselink converters. 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.
Author
Guy Pelletier
Since
EclipseLink 1.2

Field Summary

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
protected
MetadataConverter()

INTERNAL: Used for defaulting case.

protected
MetadataConverter(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

protected
MetadataConverter(MetadataAnnotation converter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
MetadataConverter(String xmlElement)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare
)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public abstract void
process(DatabaseMapping mapping, MappingAccessor accessor, MetadataClass referenceClass, boolean isForMapKey)

INTERNAL: Every converter needs to be able to process themselves.

protected void
setConverter(DatabaseMapping mapping, Converter converter, boolean isForMapKey)

INTERNAL:

protected void
setConverterClassName(DatabaseMapping mapping, String converterClassName, boolean isForMapKey)

INTERNAL:

protected void
setFieldClassification(DatabaseMapping mapping, Class<?> classification, boolean isForMapKey)

INTERNAL: Wrapper method to make sure we always set the classification name and not class.

protected void
setFieldClassification(DatabaseMapping mapping, MetadataClass classification, boolean isForMapKey)

INTERNAL: Wrapper method to make sure we always set the classification name and not class.

private void
setFieldClassification(DatabaseMapping mapping, String classificationName, boolean isForMapKey)

INTERNAL: Users should call one of the wrapper methods, likely the one that accepts a MetadataClass as we want to make sure getJavaClassName is called since it does extra goodies to make sure we get a class name that can be loaded via Class.forName()

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Constructor Detail

MetadataConverterback to summary
protected MetadataConverter()

INTERNAL: Used for defaulting case.

MetadataConverterback to summary
protected MetadataConverter(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

MetadataConverterback to summary
protected MetadataConverter(MetadataAnnotation converter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

MetadataConverterback to summary
protected MetadataConverter(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
processback to summary
public abstract void process(DatabaseMapping mapping, MappingAccessor accessor, MetadataClass referenceClass, boolean isForMapKey)

INTERNAL: Every converter needs to be able to process themselves.

setConverterback to summary
protected void setConverter(DatabaseMapping mapping, Converter converter, boolean isForMapKey)

INTERNAL:

setConverterClassNameback to summary
protected void setConverterClassName(DatabaseMapping mapping, String converterClassName, boolean isForMapKey)

INTERNAL:

setFieldClassificationback to summary
protected void setFieldClassification(DatabaseMapping mapping, Class<?> classification, boolean isForMapKey)

INTERNAL: Wrapper method to make sure we always set the classification name and not class. This class name will be initialized at run time with the real class loader.

setFieldClassificationback to summary
protected void setFieldClassification(DatabaseMapping mapping, MetadataClass classification, boolean isForMapKey)

INTERNAL: Wrapper method to make sure we always set the classification name and not class. This class name will be initialized at run time with the real class loader.

setFieldClassificationback to summary
private void setFieldClassification(DatabaseMapping mapping, String classificationName, boolean isForMapKey)

INTERNAL: Users should call one of the wrapper methods, likely the one that accepts a MetadataClass as we want to make sure getJavaClassName is called since it does extra goodies to make sure we get a class name that can be loaded via Class.forName()