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

public Class ForeignKeyMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.columns.PrimaryKeyForeignKeyMetadata
Imports
java.util.List, org.eclipse.persistence.internal.helper.DatabaseTable, org.eclipse.persistence.internal.jpa.metadata.MetadataConstants, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.tools.schemaframework.ForeignKeyConstraint
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.
Author
Guy Pelletier
Since
EclipseLink 2.5

Field Summary

Modifier and TypeField and Description
protected String
m_constraintMode

protected String
m_foreignKeyDefinition

protected String
m_name

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
ForeignKeyMetadata()

INTERNAL: Used for XML loading.

public
ForeignKeyMetadata(ForeignKeyMetadata foreignKey)

INTERNAL: Used for annotation loading from subclasses of ForeignKeyMetadata.

public
ForeignKeyMetadata(MetadataAnnotation foreignKey, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

public
ForeignKeyMetadata(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)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public String
getConstraintMode()

INTERNAL: Used for OX mapping.

public String
getForeignKeyDefinition()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
protected boolean
isConstraintMode()

INTERNAL:

protected boolean
isNoConstraintMode()

INTERNAL:

protected boolean
isProviderDefaultConstraintMode()

INTERNAL:

public void
process(DatabaseTable table)

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

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

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

public void
setConstraintMode(String constraintMode)

INTERNAL: Used for OX mapping.

public void
setForeignKeyDefinition(String foreignKeyDefinition)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_constraintModeback to summary
protected String m_constraintMode
m_foreignKeyDefinitionback to summary
protected String m_foreignKeyDefinition
m_nameback to summary
protected String m_name

Constructor Detail

ForeignKeyMetadataback to summary
public ForeignKeyMetadata()

INTERNAL: Used for XML loading.

ForeignKeyMetadataback to summary
public ForeignKeyMetadata(ForeignKeyMetadata foreignKey)

INTERNAL: Used for annotation loading from subclasses of ForeignKeyMetadata.

ForeignKeyMetadataback to summary
public ForeignKeyMetadata(MetadataAnnotation foreignKey, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

ForeignKeyMetadataback to summary
public ForeignKeyMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.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
getConstraintModeback to summary
public String getConstraintMode()

INTERNAL: Used for OX mapping.

getForeignKeyDefinitionback to summary
public String getForeignKeyDefinition()

INTERNAL: Used for OX mapping.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
isConstraintModeback to summary
protected boolean isConstraintMode()

INTERNAL:

isNoConstraintModeback to summary
protected boolean isNoConstraintMode()

INTERNAL:

isProviderDefaultConstraintModeback to summary
protected boolean isProviderDefaultConstraintMode()

INTERNAL:

processback to summary
public void process(DatabaseTable table)

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

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

INTERNAL: Process this JPA metadata into an EclipseLink ForeignKeyConstraint.

setConstraintModeback to summary
public void setConstraintMode(String constraintMode)

INTERNAL: Used for OX mapping.

setForeignKeyDefinitionback to summary
public void setForeignKeyDefinition(String foreignKeyDefinition)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.