org.eclipse.persistence.internal.jpa.metadata.columns

Class RelationalColumnMetadata

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

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

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

Direct Known Subclasses:

JoinColumnMetadata, PrimaryKeyJoinColumnMetadata

public abstract class RelationalColumnMetadata
extends MetadataColumn

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.

Since:

EclipseLink 1.2

Author:

Guy Pelletier

Constructor Summary

Constructors

Constructor and Description
RelationalColumnMetadata(MetadataAnnotation relationalColumn, MetadataAccessor accessor) INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
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.
java.lang.String	getReferencedColumnName() INTERNAL: Used for OX mapping.
boolean	isForeignKeyFieldNotSpecified() INTERNAL:
boolean	isPrimaryKeyFieldNotSpecified() INTERNAL:
void	setReferencedColumnName(java.lang.String referencedColumnName) INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.columns.MetadataColumn

getColumnDefinition, getDatabaseField, getName, setColumnDefinition, setName

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getEntityMappings, getJavaClass, getJavaClassName, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, initXMLObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelationalColumnMetadata

public RelationalColumnMetadata(MetadataAnnotation relationalColumn,
                                MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Overrides:

equals in class MetadataColumn

getForeignKeyField

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.

getReferencedColumnName

public java.lang.String getReferencedColumnName()

INTERNAL: Used for OX mapping.

isForeignKeyFieldNotSpecified

public boolean isForeignKeyFieldNotSpecified()

INTERNAL:

isPrimaryKeyFieldNotSpecified

public boolean isPrimaryKeyFieldNotSpecified()

INTERNAL:

setReferencedColumnName

public void setReferencedColumnName(java.lang.String referencedColumnName)

INTERNAL: Used for OX mapping.