Top Description Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.columns

public Class PrimaryKeyJoinColumnMetadata

extends RelationalColumnMetadata
Class Inheritance
Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataProject, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Object to process JPA primary key join columns EclipseLink database fields. 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

Constructor Summary

AccessConstructor and Description
public
PrimaryKeyJoinColumnMetadata()

INTERNAL: Used for XML loading.

public
PrimaryKeyJoinColumnMetadata(MetadataProject project)

INTERNAL: Used for annotation loading.

public
PrimaryKeyJoinColumnMetadata(MetadataAnnotation primaryKeyJoinColumn, 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.columns.RelationalColumnMetadata.equals.

INTERNAL:
public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.hashCode.

Returns a hash code value for the object.
Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata:
getForeignKeygetForeignKeyFieldgetForeignKeyFieldgetReferencedColumnNamehasForeignKeyisForeignKeyFieldNotSpecifiedisPrimaryKeyFieldNotSpecifiedsetForeignKeysetReferencedColumnName

Constructor Detail

PrimaryKeyJoinColumnMetadataback to summary
public PrimaryKeyJoinColumnMetadata()

INTERNAL: Used for XML loading.

PrimaryKeyJoinColumnMetadataback to summary
public PrimaryKeyJoinColumnMetadata(MetadataProject project)

INTERNAL: Used for annotation loading.

PrimaryKeyJoinColumnMetadataback to summary
public PrimaryKeyJoinColumnMetadata(MetadataAnnotation primaryKeyJoinColumn, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.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
hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.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