Package org.cristalise.kernel.persistency

Enum Class ClusterType

java.lang.Object
java.lang.Enum<ClusterType>
org.cristalise.kernel.persistency.ClusterType
All Implemented Interfaces:
Serializable, Comparable<ClusterType>, Constable
public enum ClusterType extends Enum<ClusterType>

  • Enum Constant Details

    • 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:

    • 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 Details

    • values

      public static ClusterType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ClusterType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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)
      Retrieves the value from the clusterName or null if no matching was found
      Parameters:
      name - the clusterName
      Returns:
      the ClusterType or null

    • getFromPath

      public static ClusterType getFromPath(String path)
      Retrieves the value from the given path or null if no matching was found
      Parameters:
      path - slash separated string starting with the name of the ClusterType
      Returns:
      the ClusterType or null