Module org.eclipse.persistence.jpa

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

Class RelationalTableMetadata

java.lang.Object

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

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

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

Direct Known Subclasses:

CollectionTableMetadata, JoinTableMetadata

public class RelationalTableMetadata
extends TableMetadata

INTERNAL: Object to hold onto a relational table metadata in an EclipseLink database table. By relational we mean one that has join columns and a foreign key specification. 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:

EclipseLink 2.5

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor	Description
RelationalTableMetadata(String xmlElement)	INTERNAL: Used for XML loading.
RelationalTableMetadata(MetadataAccessor accessor)	INTERNAL: Used for defaulting.
RelationalTableMetadata(MetadataAnnotation relationalTable, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
ForeignKeyMetadata	getForeignKey()	INTERNAL: Used for OX mapping.
List<JoinColumnMetadata>	getJoinColumns()	INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
void	processForeignKey()	INTERNAL: Process any foreign key specification for this table.
void	setForeignKey(ForeignKeyMetadata foreignKey)	INTERNAL: Used for OX mapping.
void	setJoinColumns(List<JoinColumnMetadata> joinColumns)	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata

getCatalog, getCatalogContext, getCreationSuffix, getDatabaseTable, getIndexes, getName, getNameContext, getSchema, getSchemaContext, getUniqueConstraints, processCreationSuffix, processIndexes, processUniqueConstraints, setCatalog, setCreationSuffix, setDatabaseTable, setFullyQualifiedTableName, setIndexes, setName, setSchema, setUniqueConstraints, setUseDelimiters

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

RelationalTableMetadata

public RelationalTableMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

RelationalTableMetadata

public RelationalTableMetadata(MetadataAnnotation relationalTable,
                               MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

RelationalTableMetadata

public RelationalTableMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class TableMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class TableMetadata

getForeignKey

public ForeignKeyMetadata getForeignKey()

INTERNAL: Used for OX mapping.

getJoinColumns

public List<JoinColumnMetadata> getJoinColumns()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class TableMetadata

processForeignKey

public void processForeignKey()

INTERNAL: Process any foreign key specification for this table.

Overrides:

processForeignKey in class TableMetadata

setForeignKey

public void setForeignKey(ForeignKeyMetadata foreignKey)

INTERNAL: Used for OX mapping.

setJoinColumns

public void setJoinColumns(List<JoinColumnMetadata> joinColumns)

INTERNAL: Used for OX mapping.