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

public Class TenantDiscriminatorColumnMetadata

extends DiscriminatorColumnMetadata
Class Inheritance
Imports
org.eclipse.persistence.descriptors.SingleTableMultitenantPolicy, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .MetadataLogger, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MultitenantIdAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
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.
Author
Guy Pelletier
Since
EclipseLink 2.3

Field Summary

Modifier and TypeField and Description
private String
m_contextProperty

private Boolean
m_primaryKey

private String
m_table

public static final String
NAME_DEFAULT

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

Constructor Summary

AccessConstructor and Description
public
TenantDiscriminatorColumnMetadata()

INTERNAL: Used for XML loading.

public
TenantDiscriminatorColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

public
TenantDiscriminatorColumnMetadata(MetadataAnnotation tenantDiscriminator, 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.columns.DiscriminatorColumnMetadata.equals.

INTERNAL: Required ORMetadata method used for XML merging.
public String
getContextProperty()

INTERNAL: Used for OX mapping.

public DatabaseField
getDatabaseField()

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

INTERNAL:
public Boolean
getPrimaryKey()

INTERNAL: Used for OX mapping.

public String
getTable()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

Returns a hash code value for the object.
public void
process(MetadataDescriptor descriptor, SingleTableMultitenantPolicy policy)

INTERNAL:

public void
setContextProperty(String contextProperty)

INTERNAL: Used for OX mapping.

public void
setPrimaryKey(Boolean primaryKey)

INTERNAL: Used for OX mapping.

public void
setTable(String table)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.DiscriminatorColumnMetadata:
getDiscriminatorTypegetLengthprocesssetDiscriminatorTypesetLength

Field Detail

m_contextPropertyback to summary
private String m_contextProperty
m_primaryKeyback to summary
private Boolean m_primaryKey
m_tableback to summary
private String m_table
NAME_DEFAULTback to summary
public static final String NAME_DEFAULT

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

Constructor Detail

TenantDiscriminatorColumnMetadataback to summary
public TenantDiscriminatorColumnMetadata()

INTERNAL: Used for XML loading.

TenantDiscriminatorColumnMetadataback to summary
public TenantDiscriminatorColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

TenantDiscriminatorColumnMetadataback to summary
public TenantDiscriminatorColumnMetadata(MetadataAnnotation tenantDiscriminator, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

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

INTERNAL: Required ORMetadata method used for XML merging.

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
getContextPropertyback to summary
public String getContextProperty()

INTERNAL: Used for OX mapping.

getDatabaseFieldback to summary
public DatabaseField getDatabaseField()

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

INTERNAL:

Annotations
@Override
getPrimaryKeyback to summary
public Boolean getPrimaryKey()

INTERNAL: Used for OX mapping.

getTableback to summary
public String getTable()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DiscriminatorColumnMetadata.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
processback to summary
public void process(MetadataDescriptor descriptor, SingleTableMultitenantPolicy policy)

INTERNAL:

setContextPropertyback to summary
public void setContextProperty(String contextProperty)

INTERNAL: Used for OX mapping.

setPrimaryKeyback to summary
public void setPrimaryKey(Boolean primaryKey)

INTERNAL: Used for OX mapping.

setTableback to summary
public void setTable(String table)

INTERNAL: Used for OX mapping.