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

public Class TemporalMetadata

extends MetadataConverter
Class Inheritance
Imports
org.eclipse.persistence.mappings.DatabaseMapping, org.eclipse.persistence.mappings.converters.TypeConversionConverter, org.eclipse.persistence.exceptions.ValidationException, 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

Modifier and TypeField and Description
private String
m_temporalType

Constructor Summary

AccessConstructor and Description
public
TemporalMetadata()

INTERNAL: Used for XML loading.

public
TemporalMetadata(MetadataAnnotation temporal, 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.converters.MetadataConverter.equals.

INTERNAL:
public String
getTemporalType()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static boolean
isValidTemporalType(MetadataClass cls)

INTERNAL: Returns true if the given class is a valid temporal type and must be marked temporal.

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

Implements abstract org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter.process.

INTERNAL: Every converter needs to be able to process themselves.
public void
setTemporalType(String temporalType)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter:
setConvertersetConverterClassNamesetFieldClassificationsetFieldClassification

Field Detail

m_temporalTypeback to summary
private String m_temporalType

Constructor Detail

TemporalMetadataback to summary
public TemporalMetadata()

INTERNAL: Used for XML loading.

TemporalMetadataback to summary
public TemporalMetadata(MetadataAnnotation temporal, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter.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
getTemporalTypeback to summary
public String getTemporalType()

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
isValidTemporalTypeback to summary
public static boolean isValidTemporalType(MetadataClass cls)

INTERNAL: Returns true if the given class is a valid temporal type and must be marked temporal.

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

Implements abstract org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter.process.

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

Annotations
@Override
setTemporalTypeback to summary
public void setTemporalType(String temporalType)

INTERNAL: Used for OX mapping.