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

public Class TenantTableDiscriminatorMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.annotations.TenantTableDiscriminatorType, org.eclipse.persistence.descriptors.TablePerMultitenantPolicy, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .MetadataLogger, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
Object to hold onto tenant table discriminator metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be initialized in the initXMLObject 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.4

Field Summary

Modifier and TypeField and Description
protected String
m_contextProperty

protected String
m_type

protected static final TenantTableDiscriminatorType
TYPE_DEFAULT

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

Constructor Summary

AccessConstructor and Description
public
TenantTableDiscriminatorMetadata()

INTERNAL: Used for XML loading.

public
TenantTableDiscriminatorMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

public
TenantTableDiscriminatorMetadata(MetadataAnnotation tenantTableDiscriminator, 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: Required ORMetadata method used for XML merging.
public String
getContextProperty()

INTERNAL: Used for OX mapping.

public String
getType()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

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

INTERNAL:

public void
setContextProperty(String contextProperty)

INTERNAL: Used for OX mapping.

public void
setType(String type)

INTERNAL: Used for OX mapping.

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

Field Detail

m_contextPropertyback to summary
protected String m_contextProperty
m_typeback to summary
protected String m_type
TYPE_DEFAULTback to summary
protected static final TenantTableDiscriminatorType TYPE_DEFAULT

Constructor Detail

TenantTableDiscriminatorMetadataback to summary
public TenantTableDiscriminatorMetadata()

INTERNAL: Used for XML loading.

TenantTableDiscriminatorMetadataback to summary
public TenantTableDiscriminatorMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

TenantTableDiscriminatorMetadataback to summary
public TenantTableDiscriminatorMetadata(MetadataAnnotation tenantTableDiscriminator, 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: 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.

getTypeback to summary
public String getType()

INTERNAL: Used for OX mapping.

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
processback to summary
public void process(MetadataDescriptor descriptor, TablePerMultitenantPolicy policy)

INTERNAL:

setContextPropertyback to summary
public void setContextProperty(String contextProperty)

INTERNAL: Used for OX mapping.

setTypeback to summary
public void setType(String type)

INTERNAL: Used for OX mapping.