org.cristalise.kernel.persistency

Enum ClusterType

java.lang.Object

java.lang.Enum<ClusterType>

org.cristalise.kernel.persistency.ClusterType

All Implemented Interfaces:

Serializable, Comparable<ClusterType>

public enum ClusterType
extends Enum<ClusterType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTACHMENT
COLLECTION The root of the Collection object cluster.
HISTORY This is the cluster that contains all event for this Item.
JOB Agents store their persistent jobs in this cluster that have been pushed to them by activities configured to do so.
LIFECYCLE The cluster which holds the Item workflow.
OUTCOME This cluster holds all outcomes of this Item.
PATH
PROPERTY The root of the Property object cluster.
ROOT The defined path of the root of the CRISTAL Kernel object cluster tree.
VIEWPOINT This cluster contains all viewpoints.

Method Summary

Modifier and Type	Method and Description
String	getName()
static ClusterType	getValue(String name)
String	toString()
static ClusterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClusterType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROOT

public static final ClusterType ROOT

The defined path of the root of the CRISTAL Kernel object cluster tree. A zero-length string.

PATH

public static final ClusterType PATH

PROPERTY

public static final ClusterType PROPERTY

The root of the Property object cluster. All Property paths start with this. Defined as "Property". Properties are stored underneath according to their name e.g. "Property/Name"

COLLECTION

public static final ClusterType COLLECTION

The root of the Collection object cluster. All Collection paths start with this. Defined as "Collection". Collections are stored underneath by name e.g. "Collection/Composition"

LIFECYCLE

public static final ClusterType LIFECYCLE

The cluster which holds the Item workflow. Defined as "LifeCycle". Holds the workflow inside, which is named "workflow", hence "LifeCycle/workflow".

See Also:

Workflow

OUTCOME

public static final ClusterType OUTCOME

This cluster holds all outcomes of this Item. The path to each outcome is "Outcome/Schema Name/Schema Version/Event ID"

HISTORY

public static final ClusterType HISTORY

This is the cluster that contains all event for this Item. This cluster may be instantiated in a client as a History, which is a RemoteMap. Events are stored with their ID: "/AuditTrail/Event ID"

VIEWPOINT

public static final ClusterType VIEWPOINT

This cluster contains all viewpoints. Its name is defined as "ViewPoint". The paths of viewpoint objects stored here follow this pattern: "ViewPoint/Schema Name/Viewpoint Name"

JOB

public static final ClusterType JOB

Agents store their persistent jobs in this cluster that have been pushed to them by activities configured to do so. The name is defined as "Job" and each new job received is assigned an integer ID one more than the highest already present.

ATTACHMENT

public static final ClusterType ATTACHMENT

Method Detail

values

public static ClusterType[] 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 (ClusterType c : ClusterType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClusterType valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<ClusterType>

getValue

public static ClusterType getValue(String name)