Module eclipselink

Package org.eclipse.persistence.tools.schemaframework

Class ForeignKeyConstraint

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.ConstraintObjectDefinition

org.eclipse.persistence.tools.schemaframework.ForeignKeyConstraint

All Implemented Interfaces:

Serializable, Cloneable

public class ForeignKeyConstraint
extends ConstraintObjectDefinition

Purpose: Define a foreign key from one table to another. This support composite foreign keys can constraint options.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	disableForeignKey
protected String	foreignKeyDefinition
protected boolean	shouldCascadeOnDelete
protected List<String>	targetFields
protected String	targetTable

Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor	Description
ForeignKeyConstraint()
ForeignKeyConstraint(String name, String sourceField, String targetField, String targetTable)

Method Summary

Modifier and Type	Method	Description
void	addSourceField(String sourceField)
void	addTargetField(String targetField)
void	appendDBString(Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	appendKeys(Writer writer, List<String> keys)	Deprecated, for removal: This API element is subject to removal in a future version.
void	cascadeOnDelete()	PUBLIC: Enables delete cascading on the database.
boolean	disableForeignKey()
void	dontCascadeOnDelete()	PUBLIC: Disables delete cascading on the database, this is the default.
String	getForeignKeyDefinition()
List<String>	getSourceFields()
List<String>	getTargetFields()
String	getTargetTable()
boolean	hasForeignKeyDefinition()
boolean	isDisableForeignKey()
void	setDisableForeignKey(boolean disableForeignKey)
void	setForeignKeyDefinition(String foreignKeyDefinition)
void	setShouldCascadeOnDelete(boolean shouldCascadeOnDelete)	PUBLIC: Enables delete cascading on the database.
void	setSourceFields(List<String> sourceFields)
void	setTargetFields(List<String> targetFields)
void	setTargetTable(String targetTable)
boolean	shouldCascadeOnDelete()

Methods inherited from class org.eclipse.persistence.tools.schemaframework.ConstraintObjectDefinition

buildCreationWriter, buildDeletionWriter, getOptions, setOptions

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, createOnDatabase, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

targetFields

protected List<String> targetFields

targetTable

protected String targetTable

shouldCascadeOnDelete

protected boolean shouldCascadeOnDelete

foreignKeyDefinition

protected String foreignKeyDefinition

disableForeignKey

protected boolean disableForeignKey

Constructor Detail

ForeignKeyConstraint

public ForeignKeyConstraint()

ForeignKeyConstraint

public ForeignKeyConstraint(String name,
                            String sourceField,
                            String targetField,
                            String targetTable)

Method Detail

addTargetField

public void addTargetField(String targetField)

appendDBString

@Deprecated(forRemoval=true,
            since="4.0.9")
public void appendDBString(Writer writer,
                           org.eclipse.persistence.internal.sessions.AbstractSession session)

Deprecated, for removal: This API element is subject to removal in a future version.

INTERNAL: Append the database field definition string to the table creation statement.

Overrides:

appendDBString in class ConstraintObjectDefinition

cascadeOnDelete

public void cascadeOnDelete()

PUBLIC: Enables delete cascading on the database. This must be used carefully, i.e. only private relationships.

disableForeignKey

public boolean disableForeignKey()

dontCascadeOnDelete

public void dontCascadeOnDelete()

PUBLIC: Disables delete cascading on the database, this is the default.

getForeignKeyDefinition

public String getForeignKeyDefinition()

getTargetFields

public List<String> getTargetFields()

getTargetTable

public String getTargetTable()

hasForeignKeyDefinition

public boolean hasForeignKeyDefinition()

isDisableForeignKey

public boolean isDisableForeignKey()

setDisableForeignKey

public void setDisableForeignKey(boolean disableForeignKey)

setForeignKeyDefinition

public void setForeignKeyDefinition(String foreignKeyDefinition)

setShouldCascadeOnDelete

public void setShouldCascadeOnDelete(boolean shouldCascadeOnDelete)

PUBLIC: Enables delete cascading on the database. This must be used carefully, i.e. only private relationships.

setTargetFields

public void setTargetFields(List<String> targetFields)

setTargetTable

public void setTargetTable(String targetTable)

shouldCascadeOnDelete

public boolean shouldCascadeOnDelete()

appendKeys

@Deprecated(forRemoval=true,
            since="4.0.9")
protected void appendKeys(Writer writer,
                          List<String> keys)

Deprecated, for removal: This API element is subject to removal in a future version.

addSourceField

public void addSourceField(String sourceField)

getSourceFields

public List<String> getSourceFields()

setSourceFields

public void setSourceFields(List<String> sourceFields)