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

public Class OrderColumnMetadata

extends DirectColumnMetadata
Class Inheritance
Imports
org.eclipse.persistence.annotations.OrderCorrection, .OrderCorrectionType, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .MetadataLogger, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement, .MetadataAnnotation, org.eclipse.persistence.mappings.CollectionMapping
INTERNAL: Object to process a JPA order column into an EclipseLink database field. 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

Modifier and TypeField and Description
private static final String
_ORDER

private String
m_correctionType

Constructor Summary

AccessConstructor and Description
public
OrderColumnMetadata()

INTERNAL: Used for XML loading.

public
OrderColumnMetadata(MetadataAnnotation orderColumn, 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.columns.DirectColumnMetadata.equals.

INTERNAL:
public String
getCorrectionType()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.hashCode.

Returns a hash code value for the object.
public void
process(CollectionMapping mapping, MetadataDescriptor descriptor)

INTERNAL:

public void
setCorrectionType(String correctionType)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata:
getDatabaseFieldgetInsertablegetNullablegetUpdatablesetInsertablesetNullablesetUpdatable

Field Detail

_ORDERback to summary
private static final String _ORDER
m_correctionTypeback to summary
private String m_correctionType

Constructor Detail

OrderColumnMetadataback to summary
public OrderColumnMetadata()

INTERNAL: Used for XML loading.

OrderColumnMetadataback to summary
public OrderColumnMetadata(MetadataAnnotation orderColumn, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.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
getCorrectionTypeback to summary
public String getCorrectionType()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.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
processback to summary
public void process(CollectionMapping mapping, MetadataDescriptor descriptor)

INTERNAL:

setCorrectionTypeback to summary
public void setCorrectionType(String correctionType)

INTERNAL: Used for OX mapping.