Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metadata.multitenant

Class MultitenantMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.multitenant.MultitenantMetadata

public class MultitenantMetadata
extends ORMetadata

Object to hold onto multi-tenant 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.

Since:

EclipseLink 2.3

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor	Description
MultitenantMetadata()	INTERNAL: Used for XML loading.
MultitenantMetadata(MetadataAnnotation multitenant, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
Boolean	getIncludeCriteria()	INTERNAL: Used for OX mapping.
List<TenantDiscriminatorColumnMetadata>	getTenantDiscriminatorColumns()	INTERNAL: Used for OX mapping.
TenantTableDiscriminatorMetadata	getTenantTableDiscriminator()	INTERNAL: Used for OX mapping.
String	getType()	INTERNAL: Used for OX mapping.
int	hashCode()
boolean	includeCriteria()	INTERNAL:
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
void	process(MetadataDescriptor descriptor)	INTERNAL:
protected void	processTenantDiscriminators(MetadataDescriptor descriptor, SingleTableMultitenantPolicy policy)	INTERNAL: Process the tenant discriminator metadata.
protected void	processTenantTableDiscriminator(MetadataDescriptor descriptor, TablePerMultitenantPolicy policy)	INTERNAL: Process the tenant table discriminator metadata.
void	setIncludeCriteria(Boolean includeCriteria)	INTERNAL: Used for OX mapping.
void	setTenantDiscriminatorColumns(List<TenantDiscriminatorColumnMetadata> tenantDiscriminatorColumns)	INTERNAL: Used for OX mapping.
void	setTenantTableDiscriminator(TenantTableDiscriminatorMetadata tenantTableDiscriminator)	INTERNAL: Used for OX mapping.
void	setType(String type)	INTERNAL: Used for OX mapping.

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, 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

Constructor Detail

MultitenantMetadata

public MultitenantMetadata()

INTERNAL: Used for XML loading.

MultitenantMetadata

public MultitenantMetadata(MetadataAnnotation multitenant,
                           MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getIncludeCriteria

public Boolean getIncludeCriteria()

INTERNAL: Used for OX mapping.

getTenantDiscriminatorColumns

public List<TenantDiscriminatorColumnMetadata> getTenantDiscriminatorColumns()

INTERNAL: Used for OX mapping.

getTenantTableDiscriminator

public TenantTableDiscriminatorMetadata getTenantTableDiscriminator()

INTERNAL: Used for OX mapping.

getType

public String getType()

INTERNAL: Used for OX mapping.

includeCriteria

public boolean includeCriteria()

INTERNAL:

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

process

public void process(MetadataDescriptor descriptor)

INTERNAL:

processTenantDiscriminators

protected void processTenantDiscriminators(MetadataDescriptor descriptor,
                                           SingleTableMultitenantPolicy policy)

INTERNAL: Process the tenant discriminator metadata.

processTenantTableDiscriminator

protected void processTenantTableDiscriminator(MetadataDescriptor descriptor,
                                               TablePerMultitenantPolicy policy)

INTERNAL: Process the tenant table discriminator metadata.

setIncludeCriteria

public void setIncludeCriteria(Boolean includeCriteria)

INTERNAL: Used for OX mapping.

setTenantDiscriminatorColumns

public void setTenantDiscriminatorColumns(List<TenantDiscriminatorColumnMetadata> tenantDiscriminatorColumns)

INTERNAL: Used for OX mapping.

setTenantTableDiscriminator

public void setTenantTableDiscriminator(TenantTableDiscriminatorMetadata tenantTableDiscriminator)

INTERNAL: Used for OX mapping.

setType

public void setType(String type)

INTERNAL: Used for OX mapping.