ollie.annotation

Enum ForeignKey.ReferentialAction

java.lang.Object

java.lang.Enum<ForeignKey.ReferentialAction>

ollie.annotation.ForeignKey.ReferentialAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ForeignKey.ReferentialAction>

Enclosing class:

ForeignKey

public static enum ForeignKey.ReferentialAction
extends java.lang.Enum<ForeignKey.ReferentialAction>

Perform an action on referenced rows on update and delete.

http://www.sqlite.org/foreignkeys.html#fk_actions

Enum Constant Summary

Enum Constants

Enum Constant and Description
CASCADE A "CASCADE" action propagates the delete or update operation on the parent key to each dependent child key.
NO_ACTION Configuring "NO ACTION" means just that: when a parent key is modified or deleted from the database, no special action is taken.
NONE No action.
RESTRICT The "RESTRICT" action means that the application is prohibited from deleting (for ON DELETE RESTRICT) or modifying (for ON UPDATE RESTRICT) a parent key when there exists one or more child keys mapped to it.
SET_DEFAULT The "SET DEFAULT" actions are similar to "SET NULL", except that each of the child key columns is set to contain the columns default value instead of NULL.
SET_NULL If the configured action is "SET NULL", then when a parent key is deleted (for ON DELETE SET NULL) or modified (for ON UPDATE SET NULL), the child key columns of all rows in the child table that mapped to the parent key are set to contain SQL NULL values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	keyword() Returns a keyword string for the referential action.
static ForeignKey.ReferentialAction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ForeignKey.ReferentialAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final ForeignKey.ReferentialAction NONE

No action.

SET_NULL

public static final ForeignKey.ReferentialAction SET_NULL

If the configured action is "SET NULL", then when a parent key is deleted (for ON DELETE SET NULL) or modified (for ON UPDATE SET NULL), the child key columns of all rows in the child table that mapped to the parent key are set to contain SQL NULL values.

SET_DEFAULT

public static final ForeignKey.ReferentialAction SET_DEFAULT

The "SET DEFAULT" actions are similar to "SET NULL", except that each of the child key columns is set to contain the columns default value instead of NULL. Refer to the CREATE TABLE documentation for details on how default values are assigned to table columns.

CASCADE

public static final ForeignKey.ReferentialAction CASCADE

A "CASCADE" action propagates the delete or update operation on the parent key to each dependent child key. For an "ON DELETE CASCADE" action, this means that each row in the child table that was associated with the deleted parent row is also deleted. For an "ON UPDATE CASCADE" action, it means that the values stored in each dependent child key are modified to match the new parent key values.

RESTRICT

public static final ForeignKey.ReferentialAction RESTRICT

The "RESTRICT" action means that the application is prohibited from deleting (for ON DELETE RESTRICT) or modifying (for ON UPDATE RESTRICT) a parent key when there exists one or more child keys mapped to it. The difference between the effect of a RESTRICT action and normal foreign key constraint enforcement is that the RESTRICT action processing happens as soon as the field is updated - not at the end of the current statement as it would with an immediate constraint, or at the end of the current transaction as it would with a deferred constraint. Even if the foreign key constraint it is attached to is deferred, configuring a RESTRICT action causes SQLite to return an error immediately if a parent key with dependent child keys is deleted or modified.

NO_ACTION

public static final ForeignKey.ReferentialAction NO_ACTION

Configuring "NO ACTION" means just that: when a parent key is modified or deleted from the database, no special action is taken.

Method Detail

values

public static ForeignKey.ReferentialAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ForeignKey.ReferentialAction c : ForeignKey.ReferentialAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ForeignKey.ReferentialAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

keyword

public java.lang.String keyword()

Returns a keyword string for the referential action.

Returns:

The keyword.