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

public Class JoinTableMetadata

extends RelationalTableMetadata
Class Inheritance
Imports
java.util.ArrayList, .List, org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, 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 join table metadata in a EclipseLink 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 ForeignKeyMetadata
m_inverseForeignKey

private List<JoinColumnMetadata>
m_inverseJoinColumns

Constructor Summary

AccessConstructor and Description
public
JoinTableMetadata()

INTERNAL: Used for XML loading.

public
JoinTableMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

public
JoinTableMetadata(MetadataAnnotation joinTable, 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.RelationalTableMetadata.equals.

INTERNAL:
public String
getCatalogContext()

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

INTERNAL:
public ForeignKeyMetadata
getInverseForeignKey()

INTERNAL: Used for OX mapping.

public List<JoinColumnMetadata>
getInverseJoinColumns()

INTERNAL: Used for OX mapping.

public String
getNameContext()

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

INTERNAL:
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.RelationalTableMetadata.hashCode.

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

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

INTERNAL:
public void
processForeignKey()

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

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

INTERNAL: Used for OX mapping.

public void
setInverseJoinColumns(List<JoinColumnMetadata> inverseJoinColumns)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.tables.RelationalTableMetadata:
getForeignKeygetJoinColumnssetForeignKeysetJoinColumns

Field Detail

m_inverseForeignKeyback to summary
private ForeignKeyMetadata m_inverseForeignKey
m_inverseJoinColumnsback to summary
private List<JoinColumnMetadata> m_inverseJoinColumns

Constructor Detail

JoinTableMetadataback to summary
public JoinTableMetadata()

INTERNAL: Used for XML loading.

JoinTableMetadataback to summary
public JoinTableMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

JoinTableMetadataback to summary
public JoinTableMetadata(MetadataAnnotation joinTable, 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.RelationalTableMetadata.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
getInverseForeignKeyback to summary
public ForeignKeyMetadata getInverseForeignKey()

INTERNAL: Used for OX mapping.

getInverseJoinColumnsback to summary
public List<JoinColumnMetadata> getInverseJoinColumns()

INTERNAL: Used for OX mapping.

getNameContextback to summary
public String getNameContext()

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

INTERNAL:

Annotations
@Override
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.RelationalTableMetadata.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.RelationalTableMetadata.initXMLObject.

INTERNAL:

Annotations
@Override
processForeignKeyback to summary
public void processForeignKey()

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

INTERNAL: Process any foreign key specification for this table.

Annotations
@Override
setInverseForeignKeyback to summary
public void setInverseForeignKey(ForeignKeyMetadata inverseForeignKey)

INTERNAL: Used for OX mapping.

setInverseJoinColumnsback to summary
public void setInverseJoinColumns(List<JoinColumnMetadata> inverseJoinColumns)

INTERNAL: Used for OX mapping.