oracle.javatools.db

Class FKConstraint

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.Constraint

oracle.javatools.db.ColumnConstraint

oracle.javatools.db.FKConstraint

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class FKConstraint
extends ColumnConstraint

A FKConstraint represents a Foreign Key Constraint. A foreign key constraint requires values in the constrained table to match values in another table.

An FKConstraint contains a reference to a UniqueConstraint. This referenced constraint determines the valid values for the columns constrained.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FKConstraint.ReferentialAction The action to take "ON DELETE" or "ON UPDATE" for a FK (where supported by the underlying Database).

Nested classes/interfaces inherited from class oracle.javatools.db.Constraint

Constraint.DeferrableState

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONSTRAINT_TYPE
static int	ON_DELETE_CASCADE Deprecated. use ReferentialAction.CASCADE instead
static int	ON_DELETE_RESTRICT Deprecated. use ReferentialAction.RESTRICT instead
static int	ON_DELETE_SET_NULL Deprecated. use ReferentialAction.SET_NULL instead

Fields inherited from class oracle.javatools.db.Constraint

TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
FKConstraint() Constructs a new FKConstraint.
FKConstraint(java.lang.String name, Relation relation) Constructs a new FKConstraint with the specified name for the specified relation.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConstraintType() Retrieves the type of constraint represented by this instance.
int	getDeleteMode() Deprecated. replaced by getOnDeleteAction()
FKConstraint.ReferentialAction	getOnDeleteAction() Gets the "referential action" that the database will take on delete of a row contained in the referenced table.
DBObjectID	getReferenceID() Retrieves the Object ID of the referenced unique constraint.
void	setDeleteMode(int onDelete) Deprecated. replaced by setOnDeleteAction(oracle.javatools.db.FKConstraint.ReferentialAction)
void	setOnDeleteAction(FKConstraint.ReferentialAction action) Sets the "referential action" that the database will take on delete of a row contained in the referenced table.
void	setReferenceID(DBObjectID id) Sets the Object ID of the referenced unique constraint.

Methods inherited from class oracle.javatools.db.ColumnConstraint

addColumn, addColumnImpl, getColumnIDs, getColumns, isConstrained, removeColumn, setColumnIDs, setColumns

Methods inherited from class oracle.javatools.db.Constraint

getConstraints, getConstraintTypes, getDeferrableState, getRelation, getType, isEnabled, setDeferrableState, setEnabled, setRelation

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

CONSTRAINT_TYPE

public static final java.lang.String CONSTRAINT_TYPE

See Also:

Constant Field Values

ON_DELETE_RESTRICT

@Deprecated
public static final int ON_DELETE_RESTRICT

Deprecated. use ReferentialAction.RESTRICT instead

See Also:

Constant Field Values

ON_DELETE_CASCADE

@Deprecated
public static final int ON_DELETE_CASCADE

Deprecated. use ReferentialAction.CASCADE instead

See Also:

Constant Field Values

ON_DELETE_SET_NULL

@Deprecated
public static final int ON_DELETE_SET_NULL

Deprecated. use ReferentialAction.SET_NULL instead

See Also:

Constant Field Values

Constructor Detail

FKConstraint

public FKConstraint()

Constructs a new FKConstraint.

FKConstraint

public FKConstraint(java.lang.String name,
            Relation relation)

Constructs a new FKConstraint with the specified name for the specified relation. The new constraint will not be added to the Table, this must be done using Relation.addConstraint(Constraint) when the constraint definition is complete.

Parameters:

name - a string containing the name of the constraint

relation - the relation being constrained.

Method Detail

setReferenceID

public void setReferenceID(DBObjectID id)

Sets the Object ID of the referenced unique constraint.

Parameters:

id - The DBObjectID of the referenced constraint

getReferenceID

public DBObjectID getReferenceID()

Retrieves the Object ID of the referenced unique constraint.

Returns:

The DBObjectID of the referenced constraint

getConstraintType

public java.lang.String getConstraintType()

Description copied from class: Constraint

Retrieves the type of constraint represented by this instance. Valid constraint types can vary depending on the database. Examples of constraint types include primary key constraints, foreign key constraints, and check constraints.

Specified by:

getConstraintType in class Constraint

Returns:

a string value indicating the type of constraint.

getOnDeleteAction

public FKConstraint.ReferentialAction getOnDeleteAction()

Gets the "referential action" that the database will take on delete of a row contained in the referenced table.

setOnDeleteAction

public void setOnDeleteAction(FKConstraint.ReferentialAction action)

Sets the "referential action" that the database will take on delete of a row contained in the referenced table.

getDeleteMode

@Deprecated
public int getDeleteMode()

Deprecated. replaced by getOnDeleteAction()

setDeleteMode

@Deprecated
public void setDeleteMode(int onDelete)

Deprecated. replaced by setOnDeleteAction(oracle.javatools.db.FKConstraint.ReferentialAction)