org.apache.ddlutils.model

Class CascadeActionEnum

java.lang.Object

org.apache.commons.lang.enums.Enum

org.apache.commons.lang.enums.ValuedEnum

org.apache.ddlutils.model.CascadeActionEnum

All Implemented Interfaces:

Serializable, Comparable

public class CascadeActionEnum
extends org.apache.commons.lang.enums.ValuedEnum

Represents the different cascade actions for the onDelete and onUpdate properties of ForeignKey.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CascadeActionEnum	CASCADE The enum value for a cascade action which directs the database to apply the change to the referenced table also to this table.
static CascadeActionEnum	NONE The enum value for the cascade action that directs the database to not change the local column when the value of the referenced column changes, only check the foreign key constraint.
static CascadeActionEnum	RESTRICT The enum value for a cascade action which directs the database to restrict the change changes to the referenced column.
static CascadeActionEnum	SET_DEFAULT The enum value for a cascade action which directs the database to set the local columns referenced by the foreign key to the default value when the referenced row changes/is deleted.
static CascadeActionEnum	SET_NULL The enum value for a cascade action which directs the database to set the local columns referenced by the foreign key to null when the referenced row changes/is deleted.
static int	VALUE_CASCADE The integer value for the enum value for a cascade action.
static int	VALUE_NONE The integer value for the enum value for no-action.
static int	VALUE_RESTRICT The integer value for the enum value for a restrict action.
static int	VALUE_SET_DEFAULT The integer value for the enum value for a set-null action.
static int	VALUE_SET_NULL The integer value for the enum value for a set-null action.

Fields inherited from class org.apache.commons.lang.enums.Enum

iToString

Method Summary

Methods

Modifier and Type	Method and Description
static CascadeActionEnum	getEnum(int intValue) Returns the enum value that corresponds to the given integer representation.
static CascadeActionEnum	getEnum(String defaultTextRep) Returns the enum value that corresponds to the given textual representation.
static List	getEnumList() Returns a list of all enum values.
static Map	getEnumMap() Returns the map of enum values.
static Iterator	iterator() Returns an iterator of all enum values.

Methods inherited from class org.apache.commons.lang.enums.ValuedEnum

compareTo, getEnum, getValue, toString

Methods inherited from class org.apache.commons.lang.enums.Enum

equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_CASCADE

public static final int VALUE_CASCADE

The integer value for the enum value for a cascade action.

See Also:

Constant Field Values

VALUE_SET_NULL

public static final int VALUE_SET_NULL

The integer value for the enum value for a set-null action.

See Also:

Constant Field Values

VALUE_SET_DEFAULT

public static final int VALUE_SET_DEFAULT

The integer value for the enum value for a set-null action.

See Also:

Constant Field Values

VALUE_RESTRICT

public static final int VALUE_RESTRICT

The integer value for the enum value for a restrict action.

See Also:

Constant Field Values

VALUE_NONE

public static final int VALUE_NONE

The integer value for the enum value for no-action.

See Also:

Constant Field Values

CASCADE

public static final CascadeActionEnum CASCADE

The enum value for a cascade action which directs the database to apply the change to the referenced table also to this table. E.g. if the referenced row is deleted, then the local one will also be deleted when this value is used for the onDelete action.

SET_NULL

public static final CascadeActionEnum SET_NULL

The enum value for a cascade action which directs the database to set the local columns referenced by the foreign key to null when the referenced row changes/is deleted.

SET_DEFAULT

public static final CascadeActionEnum SET_DEFAULT

The enum value for a cascade action which directs the database to set the local columns referenced by the foreign key to the default value when the referenced row changes/is deleted.

RESTRICT

public static final CascadeActionEnum RESTRICT

The enum value for a cascade action which directs the database to restrict the change changes to the referenced column. The interpretation of this is database-dependent, but it is usually the same as NONE.

NONE

public static final CascadeActionEnum NONE

The enum value for the cascade action that directs the database to not change the local column when the value of the referenced column changes, only check the foreign key constraint.

Method Detail

getEnum

public static CascadeActionEnum getEnum(String defaultTextRep)

Returns the enum value that corresponds to the given textual representation.

Parameters:

defaultTextRep - The textual representation

Returns:

The enum value

getEnum

public static CascadeActionEnum getEnum(int intValue)

Returns the enum value that corresponds to the given integer representation.

Parameters:

intValue - The integer value

Returns:

The enum value

getEnumMap

public static Map getEnumMap()

Returns the map of enum values.

Returns:

The map of enum values

getEnumList

public static List getEnumList()

Returns a list of all enum values.

Returns:

The list of enum values

iterator

public static Iterator iterator()

Returns an iterator of all enum values.

Returns:

The iterator