org.eclipse.persistence.internal.jpa.metadata.columns

Class DiscriminatorColumnMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.columns.MetadataColumn

org.eclipse.persistence.internal.jpa.metadata.columns.DiscriminatorColumnMetadata

Direct Known Subclasses:

TenantDiscriminatorColumnMetadata

public class DiscriminatorColumnMetadata
extends MetadataColumn

INTERNAL: Object to process a JPA discriminator 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.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME_DEFAULT

Constructor Summary

Constructors

Constructor and Description
DiscriminatorColumnMetadata() INTERNAL: Used for XML loading.
DiscriminatorColumnMetadata(MetadataAccessor accessor) INTERNAL: Used for defaulting.
DiscriminatorColumnMetadata(MetadataAnnotation discriminatorColumn, MetadataAccessor accessor) INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
DatabaseField	getDatabaseField() INTERNAL:
java.lang.String	getDiscriminatorType() INTERNAL: Used for OX mapping.
java.lang.Integer	getLength() INTERNAL: Used for OX mapping.
DatabaseField	process(MetadataDescriptor descriptor, java.lang.String loggingCtx) INTERNAL: Process a discriminator column metadata into an EclipseLink DatabaseField.
void	setDiscriminatorType(java.lang.String descriminatorType) INTERNAL: Used for OX mapping.
void	setLength(java.lang.Integer length) INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.columns.MetadataColumn

getColumnDefinition, getName, setColumnDefinition, setName

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, initXMLObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_DEFAULT

public static final java.lang.String NAME_DEFAULT

See Also:

Constant Field Values

Constructor Detail

DiscriminatorColumnMetadata

public DiscriminatorColumnMetadata()

INTERNAL: Used for XML loading.

DiscriminatorColumnMetadata

public DiscriminatorColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

DiscriminatorColumnMetadata

public DiscriminatorColumnMetadata(MetadataAnnotation discriminatorColumn,
                                   MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Overrides:

equals in class MetadataColumn

getDiscriminatorType

public java.lang.String getDiscriminatorType()

INTERNAL: Used for OX mapping.

getDatabaseField

public DatabaseField getDatabaseField()

INTERNAL:

Overrides:

getDatabaseField in class MetadataColumn

getLength

public java.lang.Integer getLength()

INTERNAL: Used for OX mapping.

process

public DatabaseField process(MetadataDescriptor descriptor,
                             java.lang.String loggingCtx)

INTERNAL: Process a discriminator column metadata into an EclipseLink DatabaseField. What is done with that field is up to the caller of this method.

setDiscriminatorType

public void setDiscriminatorType(java.lang.String descriminatorType)

INTERNAL: Used for OX mapping.

setLength

public void setLength(java.lang.Integer length)

INTERNAL: Used for OX mapping.