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

public abstract Class RelationalColumnMetadata

extends MetadataColumn
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.columns.JoinColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.columns.PrimaryKeyJoinColumnMetadata
Imports
org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Object to process JPA relational type colummns into 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
EclipseLink 1.2

Field Summary

Modifier and TypeField and Description
private ForeignKeyMetadata
m_foreignKey

private String
m_referencedColumnName

Constructor Summary

AccessConstructor and Description
public
RelationalColumnMetadata(MetadataAnnotation relationalColumn, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
RelationalColumnMetadata(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.columns.MetadataColumn.equals.

INTERNAL:
public ForeignKeyMetadata
getForeignKey()

INTERNAL: Used for OX mapping.

protected DatabaseField
getForeignKeyField()

INTERNAL:

public DatabaseField
getForeignKeyField(DatabaseField primaryKeyField)

INTERNAL: By calling this method we will return the foreign key field with the extra metadata from the primary key field that can not be applied to a referenced column.

public String
getReferencedColumnName()

INTERNAL: Used for OX mapping.

public boolean
hasForeignKey()

INTERNAL: Return true if a foreign key has been defined on this column.

public int
hashCode()

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

Returns a hash code value for the object.
public boolean
isForeignKeyFieldNotSpecified()

INTERNAL:

public boolean
isPrimaryKeyFieldNotSpecified()

INTERNAL:

public void
setForeignKey(ForeignKeyMetadata foreignKey)

INTERNAL: Used for OX mapping.

public void
setReferencedColumnName(String referencedColumnName)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.MetadataColumn:
getColumnDefinitiongetDatabaseFieldgetNamesetColumnDefinitionsetName

Field Detail

m_foreignKeyback to summary
private ForeignKeyMetadata m_foreignKey
m_referencedColumnNameback to summary
private String m_referencedColumnName

Constructor Detail

RelationalColumnMetadataback to summary
public RelationalColumnMetadata(MetadataAnnotation relationalColumn, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

RelationalColumnMetadataback to summary
protected RelationalColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

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

getForeignKeyFieldback to summary
protected DatabaseField getForeignKeyField()

INTERNAL:

getForeignKeyFieldback to summary
public DatabaseField getForeignKeyField(DatabaseField primaryKeyField)

INTERNAL: By calling this method we will return the foreign key field with the extra metadata from the primary key field that can not be applied to a referenced column.

getReferencedColumnNameback to summary
public String getReferencedColumnName()

INTERNAL: Used for OX mapping.

hasForeignKeyback to summary
public boolean hasForeignKey()

INTERNAL: Return true if a foreign key has been defined on this column.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.MetadataColumn.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
isForeignKeyFieldNotSpecifiedback to summary
public boolean isForeignKeyFieldNotSpecified()

INTERNAL:

isPrimaryKeyFieldNotSpecifiedback to summary
public boolean isPrimaryKeyFieldNotSpecified()

INTERNAL:

setForeignKeyback to summary
public void setForeignKey(ForeignKeyMetadata foreignKey)

INTERNAL: Used for OX mapping.

setReferencedColumnNameback to summary
public void setReferencedColumnName(String referencedColumnName)

INTERNAL: Used for OX mapping.