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

public Class RelationalTableMetadata

extends TableMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.tables.CollectionTableMetadata, org.eclipse.persistence.internal.jpa.metadata.tables.JoinTableMetadata
Imports
java.util.ArrayList, .List, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.columns.ForeignKeyMetadata, .JoinColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings
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.
Author
Guy Pelletier
Since
EclipseLink 2.5

Field Summary

Modifier and TypeField and Description
private ForeignKeyMetadata
m_foreignKey

private List<JoinColumnMetadata>
m_joinColumns

Constructor Summary

AccessConstructor and Description
public
RelationalTableMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

public
RelationalTableMetadata(MetadataAnnotation relationalTable, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

public
RelationalTableMetadata(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)

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

INTERNAL:
public ForeignKeyMetadata
getForeignKey()

INTERNAL: Used for OX mapping.

public List<JoinColumnMetadata>
getJoinColumns()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

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

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

INTERNAL:
public void
processForeignKey()

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

INTERNAL: Process any foreign key specification for this table.
public void
setForeignKey(ForeignKeyMetadata foreignKey)

INTERNAL: Used for OX mapping.

public void
setJoinColumns(List<JoinColumnMetadata> joinColumns)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata:
getCataloggetCatalogContextgetCreationSuffixgetDatabaseTablegetIndexesgetNamegetNameContextgetSchemagetSchemaContextgetUniqueConstraintsprocessCreationSuffixprocessIndexesprocessUniqueConstraintssetCatalogsetCreationSuffixsetDatabaseTablesetFullyQualifiedTableNamesetIndexessetNamesetSchemasetUniqueConstraintssetUseDelimiters

Field Detail

m_foreignKeyback to summary
private ForeignKeyMetadata m_foreignKey
m_joinColumnsback to summary
private List<JoinColumnMetadata> m_joinColumns

Constructor Detail

RelationalTableMetadataback to summary
public RelationalTableMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

RelationalTableMetadataback to summary
public RelationalTableMetadata(MetadataAnnotation relationalTable, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

RelationalTableMetadataback to summary
public RelationalTableMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata.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
getForeignKeyback to summary
public ForeignKeyMetadata getForeignKey()

INTERNAL: Used for OX mapping.

getJoinColumnsback to summary
public List<JoinColumnMetadata> getJoinColumns()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata.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.tables.TableMetadata.initXMLObject.

INTERNAL:

Annotations
@Override
processForeignKeyback to summary
public void processForeignKey()

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

INTERNAL: Process any foreign key specification for this table.

Annotations
@Override
setForeignKeyback to summary
public void setForeignKey(ForeignKeyMetadata foreignKey)

INTERNAL: Used for OX mapping.

setJoinColumnsback to summary
public void setJoinColumns(List<JoinColumnMetadata> joinColumns)

INTERNAL: Used for OX mapping.