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

public Class ReadTransformerMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.transformers.WriteTransformerMetadata
Imports
org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.mappings.TransformationMapping, org.eclipse.persistence.mappings.transformers.AttributeTransformer
INTERNAL: Metadata for ReadTransformer. 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
Andrei Ilitchev
Since
EclipseLink 1.0

Field Summary

Modifier and TypeField and Description
private String
m_method

private MetadataClass
m_transformerClass

private String
m_transformerClassName

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

Constructor Summary

AccessConstructor and Description
public
ReadTransformerMetadata()

INTERNAL: Used for XML loading.

public
ReadTransformerMetadata(MetadataAnnotation readTransformer, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
ReadTransformerMetadata(String xmlElement)

INTERNAL: Used for XML loading from subclasses.

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 String
getMethod()

INTERNAL: Used for OX mapping.

public MetadataClass
getTransformerClass()

INTERNAL:

public String
getTransformerClassName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
process(TransformationMapping mapping, String annotatedElementName)

INTERNAL: When this method is called there must be either method or class (but not both!).

public void
setMethod(String method)

INTERNAL: Used for OX mapping.

public void
setTransformerClass(MetadataClass transformerClass)

INTERNAL:

public void
setTransformerClassName(String transformerClassName)

INTERNAL: Used for OX mapping.

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

Field Detail

m_methodback to summary
private String m_method
m_transformerClassback to summary
private MetadataClass m_transformerClass
m_transformerClassNameback to summary
private String m_transformerClassName

Constructor Detail

ReadTransformerMetadataback to summary
public ReadTransformerMetadata()

INTERNAL: Used for XML loading.

ReadTransformerMetadataback to summary
public ReadTransformerMetadata(MetadataAnnotation readTransformer, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

ReadTransformerMetadataback to summary
protected ReadTransformerMetadata(String xmlElement)

INTERNAL: Used for XML loading from subclasses.

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
getMethodback to summary
public String getMethod()

INTERNAL: Used for OX mapping.

getTransformerClassback to summary
public MetadataClass getTransformerClass()

INTERNAL:

getTransformerClassNameback to summary
public String getTransformerClassName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
processback to summary
public void process(TransformationMapping mapping, String annotatedElementName)

INTERNAL: When this method is called there must be either method or class (but not both!). If there was not class but className, then by now the class should have been set.

setMethodback to summary
public void setMethod(String method)

INTERNAL: Used for OX mapping.

setTransformerClassback to summary
public void setTransformerClass(MetadataClass transformerClass)

INTERNAL:

setTransformerClassNameback to summary
public void setTransformerClassName(String transformerClassName)

INTERNAL: Used for OX mapping.