Module org.eclipse.persistence.jpa

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

Class ForeignKeyMetadata

java.lang.Object

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

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

Direct Known Subclasses:

PrimaryKeyForeignKeyMetadata

public class ForeignKeyMetadata
extends ORMetadata

INTERNAL: Object to process JPA foreign key metadata. 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 2.5

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_constraintMode
protected String	m_foreignKeyDefinition
protected String	m_name

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

m_project

Constructor Summary

Constructors

Constructor	Description
ForeignKeyMetadata()	INTERNAL: Used for XML loading.
ForeignKeyMetadata(String xmlElement)	INTERNAL: Used for XML loading.
ForeignKeyMetadata(MetadataAnnotation foreignKey, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.
ForeignKeyMetadata(ForeignKeyMetadata foreignKey)	INTERNAL: Used for annotation loading from subclasses of ForeignKeyMetadata.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
String	getConstraintMode()	INTERNAL: Used for OX mapping.
String	getForeignKeyDefinition()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
int	hashCode()
protected boolean	isConstraintMode()	INTERNAL:
protected boolean	isNoConstraintMode()	INTERNAL:
protected boolean	isProviderDefaultConstraintMode()	INTERNAL:
void	process(DatabaseTable table)	INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.
void	process(DatabaseTable table, List<String> sourceFields, List<String> targetFields, DatabaseTable targetTable)	INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.
void	setConstraintMode(String constraintMode)	INTERNAL: Used for OX mapping.
void	setForeignKeyDefinition(String foreignKeyDefinition)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.

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

Field Detail

m_name

protected String m_name

m_constraintMode

protected String m_constraintMode

m_foreignKeyDefinition

protected String m_foreignKeyDefinition

Constructor Detail

ForeignKeyMetadata

public ForeignKeyMetadata()

INTERNAL: Used for XML loading.

ForeignKeyMetadata

public ForeignKeyMetadata(ForeignKeyMetadata foreignKey)

INTERNAL: Used for annotation loading from subclasses of ForeignKeyMetadata.

ForeignKeyMetadata

public ForeignKeyMetadata(MetadataAnnotation foreignKey,
                          MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

ForeignKeyMetadata

public ForeignKeyMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getConstraintMode

public String getConstraintMode()

INTERNAL: Used for OX mapping.

getForeignKeyDefinition

public String getForeignKeyDefinition()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

isConstraintMode

protected boolean isConstraintMode()

INTERNAL:

isNoConstraintMode

protected boolean isNoConstraintMode()

INTERNAL:

isProviderDefaultConstraintMode

protected boolean isProviderDefaultConstraintMode()

INTERNAL:

process

public void process(DatabaseTable table)

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

process

public void process(DatabaseTable table,
                    List<String> sourceFields,
                    List<String> targetFields,
                    DatabaseTable targetTable)

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

setConstraintMode

public void setConstraintMode(String constraintMode)

INTERNAL: Used for OX mapping.

setForeignKeyDefinition

public void setForeignKeyDefinition(String foreignKeyDefinition)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.