Module org.eclipse.persistence.jpa

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

Class JoinColumnMetadata

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

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

Direct Known Subclasses:

JoinFieldMetadata

public class JoinColumnMetadata
extends RelationalColumnMetadata

INTERNAL: Object to process JPA 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.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Modifier	Constructor	Description
	JoinColumnMetadata()	INTERNAL: Used for XML loading.
protected	JoinColumnMetadata(String xmlElement)	INTERNAL: Used for XML loading.
	JoinColumnMetadata(MetadataAnnotation joinColumn, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
protected DatabaseField	getForeignKeyField()	INTERNAL:
Boolean	getInsertable()	INTERNAL: Used for OX mapping.
Boolean	getNullable()	INTERNAL: Used for OX mapping.
String	getTable()	INTERNAL: USed for OX mapping.
Boolean	getUnique()	INTERNAL: Used for OX mapping.
Boolean	getUpdatable()	INTERNAL: Used for OX mapping.
int	hashCode()
void	setInsertable(Boolean insertable)	INTERNAL: Used for OX mapping.
void	setNullable(Boolean nullable)	INTERNAL: Used for OX mapping.
void	setTable(String table)	INTERNAL: Used for OX mapping.
void	setUnique(Boolean unique)	INTERNAL: Used for OX mapping.
void	setUpdatable(Boolean updatable)	INTERNAL: Used for OX mapping.

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

getForeignKey, getForeignKeyField, getReferencedColumnName, hasForeignKey, isForeignKeyFieldNotSpecified, isPrimaryKeyFieldNotSpecified, setForeignKey, setReferencedColumnName

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JoinColumnMetadata

public JoinColumnMetadata()

INTERNAL: Used for XML loading.

JoinColumnMetadata

protected JoinColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

JoinColumnMetadata

public JoinColumnMetadata(MetadataAnnotation joinColumn,
                          MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class RelationalColumnMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class RelationalColumnMetadata

getForeignKeyField

protected DatabaseField getForeignKeyField()

INTERNAL:

Overrides:

getForeignKeyField in class RelationalColumnMetadata

getInsertable

public Boolean getInsertable()

INTERNAL: Used for OX mapping.

getNullable

public Boolean getNullable()

INTERNAL: Used for OX mapping.

getTable

public String getTable()

INTERNAL: USed for OX mapping.

getUnique

public Boolean getUnique()

INTERNAL: Used for OX mapping.

getUpdatable

public Boolean getUpdatable()

INTERNAL: Used for OX mapping.

setInsertable

public void setInsertable(Boolean insertable)

INTERNAL: Used for OX mapping.

setNullable

public void setNullable(Boolean nullable)

INTERNAL: Used for OX mapping.

setTable

public void setTable(String table)

INTERNAL: Used for OX mapping.

setUnique

public void setUnique(Boolean unique)

INTERNAL: Used for OX mapping.

setUpdatable

public void setUpdatable(Boolean updatable)

INTERNAL: Used for OX mapping.