TenantDiscriminatorColumnMetadata (EclipseLink JPA 4.0.6 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
    - - org.eclipse.persistence.internal.jpa.metadata.columns.TenantDiscriminatorColumnMetadata

```
public class TenantDiscriminatorColumnMetadata
extends DiscriminatorColumnMetadata
```
Object to hold onto tenant discriminator metadata. 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:

EclipseLink 2.3

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
Constructor	Description
`TenantDiscriminatorColumnMetadata()`	INTERNAL: Used for XML loading.
`TenantDiscriminatorColumnMetadata(MetadataAccessor accessor)`	INTERNAL: Used for defaulting.
`TenantDiscriminatorColumnMetadata(MetadataAnnotation tenantDiscriminator, 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: Required ORMetadata method used for XML merging.
`String`	`getContextProperty()`	INTERNAL: Used for OX mapping.
`DatabaseField`	`getDatabaseField()`	INTERNAL:
`Boolean`	`getPrimaryKey()`	INTERNAL: Used for OX mapping.
`String`	`getTable()`	INTERNAL: Used for OX mapping.
`int`	`hashCode()`
`void`	`process(MetadataDescriptor descriptor, SingleTableMultitenantPolicy policy)`	INTERNAL:
`void`	`setContextProperty(String contextProperty)`	INTERNAL: Used for OX mapping.
`void`	`setPrimaryKey(Boolean primaryKey)`	INTERNAL: Used for OX mapping.
`void`	`setTable(String table)`	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.columns.DiscriminatorColumnMetadata
getDiscriminatorType, getLength, process, setDiscriminatorType, setLength

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

TenantDiscriminatorColumnMetadata
```
public TenantDiscriminatorColumnMetadata()
```
INTERNAL: Used for XML loading.

TenantDiscriminatorColumnMetadata

public TenantDiscriminatorColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

TenantDiscriminatorColumnMetadata

public TenantDiscriminatorColumnMetadata(MetadataAnnotation tenantDiscriminator,
                                         MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail
- equals
```
public boolean equals(Object objectToCompare)
```
  INTERNAL: Required ORMetadata method used for XML merging.
  
  Overrides:
  
  equals in class DiscriminatorColumnMetadata
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class DiscriminatorColumnMetadata
- getContextProperty
```
public String getContextProperty()
```
  INTERNAL: Used for OX mapping.
- getDatabaseField
```
public DatabaseField getDatabaseField()
```
  INTERNAL:
  
  Overrides:
  
  getDatabaseField in class DiscriminatorColumnMetadata
- getPrimaryKey
```
public Boolean getPrimaryKey()
```
  INTERNAL: Used for OX mapping.
- getTable
```
public String getTable()
```
  INTERNAL: Used for OX mapping.
- process
```
public void process(MetadataDescriptor descriptor,
                    SingleTableMultitenantPolicy policy)
```
  INTERNAL:
- setContextProperty
```
public void setContextProperty(String contextProperty)
```
  INTERNAL: Used for OX mapping.
- setPrimaryKey
```
public void setPrimaryKey(Boolean primaryKey)
```
  INTERNAL: Used for OX mapping.
- setTable
```
public void setTable(String table)
```
  INTERNAL: Used for OX mapping.