org.cristalise.kernel.graph.model.BuiltInVertexProperties Maven / Gradle / Ivy

Go to download
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package org.cristalise.kernel.graph.model;


/**
 * Enumeration to define all Vertex properties which are used by collection and lifecycle packages
 *
 */
public enum BuiltInVertexProperties {
    /**
     * Boolean property. Makes CompositeActitivy abortable, i.e. it can be finished even if it has active children.
     */
    ABORTABLE("Abortable"),

    ACTIVITY_DEF_NAME("ActivityDefName"),
    ACTIVITY_DEF_VERSION("ActivityDefName"),

    ACTIVITY_DEF_URN("ActivityDefURN"),

    /**
     * String property. The name of the Agent associated with Activities. Can be null or undefined.
     */
    AGENT_NAME("Agent Name"),

    /**
     * String property. The name of the Dekegate Agent associated with Activities. Can be null or undefined.
     */
    DELEGATE_NAME("DelegateName"),

    /**
     * String property. The role of the Agent associated with Activities. Can be null or undefined.
     */
    AGENT_ROLE("Agent Role"),

    /**
     * Boolean property ...
     */
    BREAKPOINT("Breakpoint"),

    /**
     * String property used in ActivityDef to store the description text
     */
    DESCRIPTION("Description"),

    /**
     * Used in Splits as a counter to provide unique ID for instances of {@link DirectedEdge}
     */
    LAST_NUM("LastNum"),

    /**
     * String property. It is used in ActivitySlotDef to override the name of the ActivityDef
     */
    NAME("Name"),

    /**
     * String property. The type of object the Activity is going to create. Values are Schema, Script, StateMachine and Query.
     * Used in script DescriptionCollectionSetter. Can be null or undefined.
     */
    OBJECT_TYPE("ObjectType"),

    /**
     * String property to hold the name of the OutcomeInititator to be used by the Job associated with Activities.
     * The name is used to find the class name defined in the Config section of the module.xml. For example, the
     * OutcomeInitiator named Empty is defined like this:
     *
     *      * {@codeorg.cristalise.kernel.persistency.outcome.EmptyOutcomeInitiator}
     * 
     *
     * Can be null or undefined.
     */
    OUTCOME_INIT("OutcomeInit"),

    /**
     * Boolean property. Enables the Loop Transition of the CompositeActivity StateMachine
     */
    REPEAT_WHEN("RepeatWhen"),

    /**
     * String property. Routing expression associated with Splits. It is interpreted by the Script class. The content should
     * start with the script engine name followed by the expression separated by a column like this:
     *
     *      * javascript: new java.lang.Integer(counter % 2);
     * 
     */
    ROUTING_EXPR("RoutingExpr"),

    /**
     * String property to hold either the name of the Script or the UUID of the Schema Item associated with Splits.
     * If RoutingScriptVersion is null the content if any is interpreted like {@link #ROUTING_EXPR}.
     *
     * Can be null or undefined.
     */
    ROUTING_SCRIPT_NAME("RoutingScriptName"),

    /**
     * Integer property to hold the version of the Schema associated with Splits.
     *
     * Can be null or undefined.
     */
    ROUTING_SCRIPT_VERSION("RoutingScriptVersion"),

    /**
     * String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities.
     *
     * Can be null or undefined.
     */
    SCHEMA_NAME("SchemaType"),

    /**
     * Integer property to hold the version of the Schema associated with Activities.
     *
     * Can be null or undefined.
     */
    SCHEMA_VERSION("SchemaVersion"),

    /**
     * String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities.
     *
     * Can be null or undefined.
     */
    SCRIPT_NAME("ScriptName"),

    /**
     * Integer property to hold the version of the Script associated with Activities.
     *
     * Can be null or undefined.
     */
    SCRIPT_VERSION("ScriptVersion"),

    /**
     * String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities.
     *
     * Can be null or undefined.
     */
    QUERY_NAME("QueryName"),

    /**
     * Integer property to hold the version of the Script associated with Activities.
     *
     * Can be null or undefined.
     */
    QUERY_VERSION("QueryVersion"),

    /**
     * String property to hold either the name of the StateMachine or the UUID of the StateMachine
     * Item associated with Activities. Can be null or undefined. The default StateMachine is called Default
     *
     * Can be null or undefined.
     */
    STATE_MACHINE_NAME("StateMachineName"),

    /**
     * Integer property to hold the version of the StateMachine associated with Activities.
     *
     * Can be null or undefined.
     */
    STATE_MACHINE_VERSION("StateMachineVersion"),

    /**
     * String property. It is used in Join and JoinDef to to specify if the join is a route or not
     *
     * Can be null or undefined.
     */
    TYPE("Type"),

    /**
     * Integer property. It is used in CollectionMember to store the version of DescriptionDependency
     */
    VERSION("Version"),

    /**
     * String property used in Script CreateNewNumberedVersionFromLast and SetLastNumberedVersionFromLast
     * to specify {@link org.cristalise.kernel.persistency.outcome.Viewpoint#setSchemaName(String)}.
     */
    VIEW_NAME("ViewName"),

    /**
     * String property used to specify {@link org.cristalise.kernel.persistency.outcome.Viewpoint#setName(String)}.
     */
    VIEW_POINT("Viewpoint");

    /**
     * Provides the actual string name of the Property used in the kernel
     */
    private String propertyName;

    private BuiltInVertexProperties(final String n) {
        propertyName = n;
    }

    /**
     * @return kernel defined string value
     */
    public String getName() {
        return propertyName;
    }

    @Override
    public String toString() {
        return getName();
    }

    public static BuiltInVertexProperties getValue(String propName) {
        for (BuiltInVertexProperties prop : BuiltInVertexProperties.values()) {
            if(prop.getName().equals(propName) || prop.name().equals(propName)) return prop;
        }
        return null;
    }

}