Module org.eclipse.persistence.jpa

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

Class TableMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata

Direct Known Subclasses:

RelationalTableMetadata, SecondaryTableMetadata, TableGeneratorMetadata

public class TableMetadata
extends ORMetadata

INTERNAL: Object to hold onto table metadata in a TopLink database table. 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 inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

m_project

Constructor Summary

Constructors

Modifier	Constructor	Description
	TableMetadata()	INTERNAL: Used for XML loading.
protected	TableMetadata(String xmlElement)	INTERNAL: Used for XML loading.
	TableMetadata(MetadataAnnotation table, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
String	getCatalog()	INTERNAL: Used for OX mapping.
String	getCatalogContext()	INTERNAL:
String	getCreationSuffix()	INTERNAL: Used for OX mapping.
DatabaseTable	getDatabaseTable()	INTERNAL:
List<IndexMetadata>	getIndexes()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
String	getNameContext()	INTERNAL:
String	getSchema()	INTERNAL: Used for OX mapping.
String	getSchemaContext()	INTERNAL:
List<UniqueConstraintMetadata>	getUniqueConstraints()	INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
void	processCreationSuffix()	INTERNAL: Process the creation suffix.
void	processForeignKey()	INTERNAL: Process any foreign key metadata for this table.
void	processIndexes()	INTERNAL: Process the index metadata for this table.
void	processUniqueConstraints()	INTERNAL: Add the unique constraints to the database table.
void	setCatalog(String catalog)	INTERNAL: Used for OX mapping.
void	setCreationSuffix(String creationSuffix)	INTERNAL: Used for OX mapping.
void	setDatabaseTable(DatabaseTable databaseTable)	INTERNAL:
void	setFullyQualifiedTableName(String fullyQualifiedTableName)	INTERNAL:
void	setIndexes(List<IndexMetadata> indexes)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.
void	setSchema(String schema)	INTERNAL: Used for OX mapping.
void	setUniqueConstraints(List<UniqueConstraintMetadata> uniqueConstraints)	INTERNAL: Used for OX mapping.
void	setUseDelimiters(boolean useDelimiters)	INTERNAL:

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

TableMetadata

public TableMetadata()

INTERNAL: Used for XML loading.

TableMetadata

public TableMetadata(MetadataAnnotation table,
                     MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

TableMetadata

protected TableMetadata(String xmlElement)

INTERNAL: Used for XML 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

getCatalog

public String getCatalog()

INTERNAL: Used for OX mapping.

getCatalogContext

public String getCatalogContext()

INTERNAL:

getCreationSuffix

public String getCreationSuffix()

INTERNAL: Used for OX mapping.

getDatabaseTable

public DatabaseTable getDatabaseTable()

INTERNAL:

getIndexes

public List<IndexMetadata> getIndexes()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

getNameContext

public String getNameContext()

INTERNAL:

getSchema

public String getSchema()

INTERNAL: Used for OX mapping.

getSchemaContext

public String getSchemaContext()

INTERNAL:

getUniqueConstraints

public List<UniqueConstraintMetadata> getUniqueConstraints()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

processCreationSuffix

public void processCreationSuffix()

INTERNAL: Process the creation suffix.

processIndexes

public void processIndexes()

INTERNAL: Process the index metadata for this table.

processForeignKey

public void processForeignKey()

INTERNAL: Process any foreign key metadata for this table.

processUniqueConstraints

public void processUniqueConstraints()

INTERNAL: Add the unique constraints to the database table.

setFullyQualifiedTableName

public void setFullyQualifiedTableName(String fullyQualifiedTableName)

INTERNAL:

setCatalog

public void setCatalog(String catalog)

INTERNAL: Used for OX mapping.

setCreationSuffix

public void setCreationSuffix(String creationSuffix)

INTERNAL: Used for OX mapping.

setDatabaseTable

public void setDatabaseTable(DatabaseTable databaseTable)

INTERNAL:

setIndexes

public void setIndexes(List<IndexMetadata> indexes)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

setSchema

public void setSchema(String schema)

INTERNAL: Used for OX mapping.

setUniqueConstraints

public void setUniqueConstraints(List<UniqueConstraintMetadata> uniqueConstraints)

INTERNAL: Used for OX mapping.

setUseDelimiters

public void setUseDelimiters(boolean useDelimiters)

INTERNAL: