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

public Class SecondaryTableMetadata

extends TableMetadata
Class Inheritance
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.PrimaryKeyForeignKeyMetadata, .PrimaryKeyJoinColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.internal.jpa.metadata.MetadataLogger
INTERNAL: Object to hold onto a secondary 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 PrimaryKeyForeignKeyMetadata
m_primaryKeyForeignKey

private List<PrimaryKeyJoinColumnMetadata>
m_primaryKeyJoinColumns

Constructor Summary

AccessConstructor and Description
public
SecondaryTableMetadata()

INTERNAL: Used for XML loading.

public
SecondaryTableMetadata(MetadataAnnotation secondaryTable, MetadataAccessor accessor)

INTERNAL: Used for annotation 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 String
getCatalogContext()

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

INTERNAL:
public String
getNameContext()

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

INTERNAL:
public PrimaryKeyForeignKeyMetadata
getPrimaryKeyForeignKey()

INTERNAL: Used for OX mapping.

public List<PrimaryKeyJoinColumnMetadata>
getPrimaryKeyJoinColumns()

INTERNAL: Used for OX mapping.

public String
getSchemaContext()

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

INTERNAL:
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 primary key foreign key specification for this table.
public void
setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey)

INTERNAL: Used for OX mapping.

public void
setPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns)

INTERNAL: Used for OX mapping.

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

Field Detail

m_primaryKeyForeignKeyback to summary
private PrimaryKeyForeignKeyMetadata m_primaryKeyForeignKey
m_primaryKeyJoinColumnsback to summary
private List<PrimaryKeyJoinColumnMetadata> m_primaryKeyJoinColumns

Constructor Detail

SecondaryTableMetadataback to summary
public SecondaryTableMetadata()

INTERNAL: Used for XML loading.

SecondaryTableMetadataback to summary
public SecondaryTableMetadata(MetadataAnnotation secondaryTable, MetadataAccessor accessor)

INTERNAL: Used for annotation 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
getCatalogContextback to summary
public String getCatalogContext()

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

INTERNAL:

Annotations
@Override
getNameContextback to summary
public String getNameContext()

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

INTERNAL:

Annotations
@Override
getPrimaryKeyForeignKeyback to summary
public PrimaryKeyForeignKeyMetadata getPrimaryKeyForeignKey()

INTERNAL: Used for OX mapping.

getPrimaryKeyJoinColumnsback to summary
public List<PrimaryKeyJoinColumnMetadata> getPrimaryKeyJoinColumns()

INTERNAL: Used for OX mapping.

getSchemaContextback to summary
public String getSchemaContext()

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

INTERNAL:

Annotations
@Override
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 primary key foreign key specification for this table.

Annotations
@Override
setPrimaryKeyForeignKeyback to summary
public void setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey)

INTERNAL: Used for OX mapping.

setPrimaryKeyJoinColumnsback to summary
public void setPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns)

INTERNAL: Used for OX mapping.