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

public Class WriteTransformerMetadata

extends ReadTransformerMetadata
Class Inheritance
Imports
org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.MetadataConstants, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.columns.ColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.mappings.TransformationMapping, org.eclipse.persistence.mappings.transformers.FieldTransformer
INTERNAL: Matadata for WriteTransformer. 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 ColumnMetadata
m_column

Constructor Summary

AccessConstructor and Description
public
WriteTransformerMetadata()

INTERNAL: Used for XML loading.

public
WriteTransformerMetadata(MetadataAnnotation writeTransformer, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Summary

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

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.equals.

INTERNAL:
public ColumnMetadata
getColumn()

INTERNAL: Used for OX mapping.

public boolean
hasFieldName()

INTERNAL: Indicates whether there is a column name.

public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.hashCode.

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

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.initXMLObject.

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

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.process.

INTERNAL:
public void
setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

public void
setFieldName(String fieldName)

INTERNAL: The name may be set by TransformationAccessor in case there's none specified.

Inherited from org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata:
getMethodgetTransformerClassgetTransformerClassNamesetMethodsetTransformerClasssetTransformerClassName

Field Detail

m_columnback to summary
private ColumnMetadata m_column

Constructor Detail

WriteTransformerMetadataback to summary
public WriteTransformerMetadata()

INTERNAL: Used for XML loading.

WriteTransformerMetadataback to summary
public WriteTransformerMetadata(MetadataAnnotation writeTransformer, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.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
getColumnback to summary
public ColumnMetadata getColumn()

INTERNAL: Used for OX mapping.

hasFieldNameback to summary
public boolean hasFieldName()

INTERNAL: Indicates whether there is a column name.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.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.transformers.ReadTransformerMetadata.initXMLObject.

INTERNAL:

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

Overrides org.eclipse.persistence.internal.jpa.metadata.transformers.ReadTransformerMetadata.process.

INTERNAL:

Annotations
@Override
setColumnback to summary
public void setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

setFieldNameback to summary
public void setFieldName(String fieldName)

INTERNAL: The name may be set by TransformationAccessor in case there's none specified.