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

public Class DiscriminatorClassMetadata

extends ORMetadata
Class Inheritance
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.VariableOneToOneMapping
INTERNAL: A discriminator class is used within a variable one to one mapping. 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.0

Field Summary

Modifier and TypeField and Description
private String
m_discriminator

private String
m_value

private MetadataClass
m_valueClass

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

Constructor Summary

AccessConstructor and Description
public
DiscriminatorClassMetadata()

INTERNAL: Used for XML loading.

public
DiscriminatorClassMetadata(MetadataAnnotation discriminatorClass, 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)

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

INTERNAL:
public String
getDiscriminator()

INTERNAL: Used for OX mapping.

public String
getValue()

INTERNAL: Used for OX mapping.

public MetadataClass
getValueClass()

INTERNAL:

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(VariableOneToOneMapping mapping)

INTERNAL: Process a discriminator class for the given variable one to one mapping.

public void
setDiscriminator(String discriminator)

INTERNAL: Used for OX mapping.

public void
setValue(String valueName)

INTERNAL: Used for OX mapping.

public void
setValueClass(MetadataClass value)

INTERNAL:

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

Field Detail

m_discriminatorback to summary
private String m_discriminator
m_valueback to summary
private String m_value
m_valueClassback to summary
private MetadataClass m_valueClass

Constructor Detail

DiscriminatorClassMetadataback to summary
public DiscriminatorClassMetadata()

INTERNAL: Used for XML loading.

DiscriminatorClassMetadataback to summary
public DiscriminatorClassMetadata(MetadataAnnotation discriminatorClass, MetadataAccessor accessor)

INTERNAL: Used for annotation 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
getDiscriminatorback to summary
public String getDiscriminator()

INTERNAL: Used for OX mapping.

getValueback to summary
public String getValue()

INTERNAL: Used for OX mapping.

getValueClassback to summary
public MetadataClass getValueClass()

INTERNAL:

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(VariableOneToOneMapping mapping)

INTERNAL: Process a discriminator class for the given variable one to one mapping.

setDiscriminatorback to summary
public void setDiscriminator(String discriminator)

INTERNAL: Used for OX mapping.

setValueback to summary
public void setValue(String valueName)

INTERNAL: Used for OX mapping.

setValueClassback to summary
public void setValueClass(MetadataClass value)

INTERNAL: