org.jpox.metadata
Class ForeignKeyAction

java.lang.Object
  org.jpox.metadata.ForeignKeyAction

All Implemented Interfaces:

java.io.Serializable

public class ForeignKeyAction
extends java.lang.Object
implements java.io.Serializable

Foreign keys represent a consistency constraint in the database that must be maintained. This class enumerates the actions which happens when foreign-keys are updated or deleted.

Version:

$Revision: 1.5 $

See Also:

Serialized Form

Field Summary

static ForeignKeyAction	CASCADE update/delete-action="cascade".
static ForeignKeyAction	DEFAULT update/delete-action="default".
static ForeignKeyAction	NONE update/delete-action="none".
static ForeignKeyAction	NULL update/delete-action="null".
static ForeignKeyAction	RESTRICT update/delete-action="restrict".

Constructor Summary

protected

ForeignKeyAction(int i) constructor

Method Summary

boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this one.
static ForeignKeyAction	getForeignKeyAction(java.lang.String value) Return ForeignKeyDeleteAction from String.
protected int	getType() Accessor for the type.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

CASCADE

public static final ForeignKeyAction CASCADE

update/delete-action="cascade". The database will automatically delete all rows that refer to the row being deleted

RESTRICT

public static final ForeignKeyAction RESTRICT

update/delete-action="restrict". The user is required to explicitly make the relationship valid by application code

NULL

public static final ForeignKeyAction NULL

update/delete-action="null". The database will automatically nullify the columns in all rows that refer to the row being deleted

DEFAULT

public static final ForeignKeyAction DEFAULT

update/delete-action="default". The database will automatically set the columns in all rows that refer to the row being deleted to their default value

NONE

public static final ForeignKeyAction NONE

update/delete-action="none". No foreign-key should be created.

Constructor Detail

ForeignKeyAction

protected ForeignKeyAction(int i)

constructor

Parameters:

i - type id

Method Detail

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

equals

public boolean equals(java.lang.Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

getType

protected int getType()

Accessor for the type.

Returns:

The type

getForeignKeyAction

public static ForeignKeyAction getForeignKeyAction(java.lang.String value)

Return ForeignKeyDeleteAction from String.

Parameters:

value - delete-action attribute value

Returns:

Instance of ForeignKeyDeleteAction. If value invalid, return null.