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

public Class TableMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.sequencing.TableGeneratorMetadata, org.eclipse.persistence.internal.jpa.metadata.tables.RelationalTableMetadata, org.eclipse.persistence.internal.jpa.metadata.tables.SecondaryTableMetadata
Imports
java.util.ArrayList, .List, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.internal.helper.DatabaseTable, .Helper
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.
Author
Guy Pelletier
Since
TopLink EJB 3.0 Reference Implementation

Field Summary

Modifier and TypeField and Description
private String
m_catalog

private String
m_creationSuffix

private DatabaseTable
m_databaseTable

private List<IndexMetadata>
m_indexes

private String
m_name

private String
m_schema

private List<UniqueConstraintMetadata>
m_uniqueConstraints

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

Constructor Summary

AccessConstructor and Description
public
TableMetadata()

INTERNAL: Used for XML loading.

public
TableMetadata(MetadataAnnotation table, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
TableMetadata(String xmlElement)

INTERNAL: Used for XML 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:
public String
getCatalog()

INTERNAL: Used for OX mapping.

public String
getCatalogContext()

INTERNAL:

public String
getCreationSuffix()

INTERNAL: Used for OX mapping.

public DatabaseTable
getDatabaseTable()

INTERNAL:

public List<IndexMetadata>
getIndexes()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public String
getNameContext()

INTERNAL:

public String
getSchema()

INTERNAL: Used for OX mapping.

public String
getSchemaContext()

INTERNAL:

public List<UniqueConstraintMetadata>
getUniqueConstraints()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
processCreationSuffix()

INTERNAL: Process the creation suffix.

public void
processForeignKey()

INTERNAL: Process any foreign key metadata for this table.

public void
processIndexes()

INTERNAL: Process the index metadata for this table.

public void
processUniqueConstraints()

INTERNAL: Add the unique constraints to the database table.

public void
setCatalog(String catalog)

INTERNAL: Used for OX mapping.

public void
setCreationSuffix(String creationSuffix)

INTERNAL: Used for OX mapping.

public void
setDatabaseTable(DatabaseTable databaseTable)

INTERNAL:

public void
setFullyQualifiedTableName(String fullyQualifiedTableName)

INTERNAL:

public void
setIndexes(List<IndexMetadata> indexes)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

public void
setSchema(String schema)

INTERNAL: Used for OX mapping.

public void
setUniqueConstraints(List<UniqueConstraintMetadata> uniqueConstraints)

INTERNAL: Used for OX mapping.

public void
setUseDelimiters(boolean useDelimiters)

INTERNAL:

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

Field Detail

m_catalogback to summary
private String m_catalog
m_creationSuffixback to summary
private String m_creationSuffix
m_databaseTableback to summary
private DatabaseTable m_databaseTable
m_indexesback to summary
private List<IndexMetadata> m_indexes
m_nameback to summary
private String m_name
m_schemaback to summary
private String m_schema
m_uniqueConstraintsback to summary
private List<UniqueConstraintMetadata> m_uniqueConstraints

Constructor Detail

TableMetadataback to summary
public TableMetadata()

INTERNAL: Used for XML loading.

TableMetadataback to summary
public TableMetadata(MetadataAnnotation table, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

TableMetadataback to summary
protected TableMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

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
getCatalogback to summary
public String getCatalog()

INTERNAL: Used for OX mapping.

getCatalogContextback to summary
public String getCatalogContext()

INTERNAL:

getCreationSuffixback to summary
public String getCreationSuffix()

INTERNAL: Used for OX mapping.

getDatabaseTableback to summary
public DatabaseTable getDatabaseTable()

INTERNAL:

getIndexesback to summary
public List<IndexMetadata> getIndexes()

INTERNAL: Used for OX mapping.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

getNameContextback to summary
public String getNameContext()

INTERNAL:

getSchemaback to summary
public String getSchema()

INTERNAL: Used for OX mapping.

getSchemaContextback to summary
public String getSchemaContext()

INTERNAL:

getUniqueConstraintsback to summary
public List<UniqueConstraintMetadata> getUniqueConstraints()

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
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
processCreationSuffixback to summary
public void processCreationSuffix()

INTERNAL: Process the creation suffix.

processForeignKeyback to summary
public void processForeignKey()

INTERNAL: Process any foreign key metadata for this table.

processIndexesback to summary
public void processIndexes()

INTERNAL: Process the index metadata for this table.

processUniqueConstraintsback to summary
public void processUniqueConstraints()

INTERNAL: Add the unique constraints to the database table.

setCatalogback to summary
public void setCatalog(String catalog)

INTERNAL: Used for OX mapping.

setCreationSuffixback to summary
public void setCreationSuffix(String creationSuffix)

INTERNAL: Used for OX mapping.

setDatabaseTableback to summary
public void setDatabaseTable(DatabaseTable databaseTable)

INTERNAL:

setFullyQualifiedTableNameback to summary
public void setFullyQualifiedTableName(String fullyQualifiedTableName)

INTERNAL:

setIndexesback to summary
public void setIndexes(List<IndexMetadata> indexes)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.

setSchemaback to summary
public void setSchema(String schema)

INTERNAL: Used for OX mapping.

setUniqueConstraintsback to summary
public void setUniqueConstraints(List<UniqueConstraintMetadata> uniqueConstraints)

INTERNAL: Used for OX mapping.

setUseDelimitersback to summary
public void setUseDelimiters(boolean useDelimiters)

INTERNAL: