com.orchestranetworks.instance
Class DefinitionMode

java.lang.Object
  com.orchestranetworks.instance.DefinitionMode

public final class DefinitionMode

extends Object

Defines the possible modes that an occurrence may have regarding its inheritance.

Field Summary

static DefinitionMode	DEFINE_DERIVE The occurrence is in deriving mode when it is defined in the current container instance and it has a parent occurrence that has a different primary key.
static DefinitionMode	DEFINE_OCCULT The occurrence is in occulting mode when it "removes its primary key" from the current table.
static DefinitionMode	DEFINE_OVERWRITE The occurrence is in overwriting mode when it is defined in the current table and it has a parent occurrence that has the same primary key.
static DefinitionMode	DEFINE_ROOT An occurrence is in root mode when it is defined in the current table and it does not inherit from a parent occurrence.
static DefinitionMode	INHERIT An occurrence is in inherit mode when it is not defined in the current table.

Method Summary

String	format() Returns a persistent identifier of this definition mode.
String	getLabel() Returns a human-readable label for this definition mode.
boolean	isDeriving() Returns true if this is DEFINE_DERIVE state.
boolean	isInherit() Returns true if this is INHERIT state.
boolean	isOcculting() Returns true if this is DEFINE_OCCULT state.
boolean	isOverwriting() Returns true if this is DEFINE_OVERWRITE state.
boolean	isRoot() Returns true if this is DEFINE_ROOT state.
static DefinitionMode	parse(String aFlag) Returns the definition mode that corresponds to the string specified.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INHERIT

public static final DefinitionMode INHERIT

An occurrence is in inherit mode when it is not defined in the current table. This implies that it inherits all its values from a parent occurrence defined in an ancestor table.

DEFINE_ROOT

public static final DefinitionMode DEFINE_ROOT

An occurrence is in root mode when it is defined in the current table and it does not inherit from a parent occurrence.

DEFINE_OVERWRITE

public static final DefinitionMode DEFINE_OVERWRITE

The occurrence is in overwriting mode when it is defined in the current table and it has a parent occurrence that has the same primary key.

The occurrence inherits its unspecified values from its parent occurrence.

DEFINE_OCCULT

public static final DefinitionMode DEFINE_OCCULT

The occurrence is in occulting mode when it "removes its primary key" from the current table.

This implies that if an occurrence in occulting mode is deleted, then the occurrence becomes inherited when it is defined in an ancestor instance

DEFINE_DERIVE

public static final DefinitionMode DEFINE_DERIVE

The occurrence is in deriving mode when it is defined in the current container instance and it has a parent occurrence that has a different primary key.

The occurrence inherits its unspecified values from its parent occurrence.

Method Detail

isInherit

public boolean isInherit()

Returns true if this is INHERIT state.

isRoot

public boolean isRoot()

Returns true if this is DEFINE_ROOT state.

isOverwriting

public boolean isOverwriting()

Returns true if this is DEFINE_OVERWRITE state.

isOcculting

public boolean isOcculting()

Returns true if this is DEFINE_OCCULT state.

isDeriving

public boolean isDeriving()

Returns true if this is DEFINE_DERIVE state.

format

public String format()

Returns a persistent identifier of this definition mode.

The persistent identifier can be parsed back by the method parse(String).

See Also:

parse(String)

parse

public static DefinitionMode parse(String aFlag)

Returns the definition mode that corresponds to the string specified.

The string specified must have been generated by the method format().

Throws:

IllegalArgumentException - if string specified is incorrect.

See Also:

format()

getLabel

public String getLabel()

Returns a human-readable label for this definition mode.

toString

public String toString()