DiscriminatorColumnMetadata (EclipseLink JPA 4.0.0 API)

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 Description

static String NAME_DEFAULT
- Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
  m_project

Constructor Summary

Constructors
Modifier	Constructor	Description
	`DiscriminatorColumnMetadata()`	INTERNAL: Used for XML loading.
`protected`	`DiscriminatorColumnMetadata(String xmlElement)`	INTERNAL: Used for XML loading.
	`DiscriminatorColumnMetadata(MetadataAccessor accessor)`	INTERNAL: Used for defaulting.
	`DiscriminatorColumnMetadata(MetadataAnnotation discriminatorColumn, MetadataAccessor accessor)`	INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	INTERNAL:
`DatabaseField`	`getDatabaseField()`	INTERNAL:
`String`	`getDiscriminatorType()`	INTERNAL: Used for OX mapping.
`Integer`	`getLength()`	INTERNAL: Used for OX mapping.
`int`	`hashCode()`
`DatabaseField`	`process(MetadataDescriptor descriptor, String loggingCtx)`	INTERNAL: Process a discriminator column metadata into an EclipseLink DatabaseField.
`void`	`setDiscriminatorType(String descriminatorType)`	INTERNAL: Used for OX mapping.
`void`	`setLength(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
getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- NAME_DEFAULT
```
public static final 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.

DiscriminatorColumnMetadata

protected DiscriminatorColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail
- equals
```
public boolean equals(Object objectToCompare)
```
  INTERNAL:
  
  Overrides:
  
  equals in class MetadataColumn
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class MetadataColumn
- getDiscriminatorType
```
public String getDiscriminatorType()
```
  INTERNAL: Used for OX mapping.
- getDatabaseField
```
public DatabaseField getDatabaseField()
```
  INTERNAL:
  
  Overrides:
  
  getDatabaseField in class MetadataColumn
- getLength
```
public Integer getLength()
```
  INTERNAL: Used for OX mapping.
- process
```
public DatabaseField process(MetadataDescriptor descriptor,
                             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(String descriminatorType)
```
  INTERNAL: Used for OX mapping.
- setLength
```
public void setLength(Integer length)
```
  INTERNAL: Used for OX mapping.