Package org.cristalise.kernel.lifecycle.instance.stateMachine

Class StateMachine

java.lang.Object

org.cristalise.kernel.lifecycle.instance.stateMachine.StateMachine

All Implemented Interfaces:

DescriptionObject

public class StateMachine
extends Object
implements DescriptionObject

Field Summary

Fields

Modifier and Type	Field	Description
ItemPath	itemPath
String	name
String	namespace
Integer	version

Constructor Summary

Constructors

Constructor	Description
StateMachine()
StateMachine(String name, Integer version)

Method Summary

Modifier and Type	Method	Description
State	createState(String name)	Factory method to create a new State for the given name.
Transition	createTransition(String name)	Factory method to create a new Transition for the given name.
static String	getDefaultStateMachine(String type)
int	getErrorTransitionIdForState(int id)
State	getInitialState()
int	getInitialStateCode()
String	getItemID()
List<Transition>	getPossibleTransitions(Activity act, AgentPath agent)
BuiltInResources	getResourceType()
State	getState(int stateID)
State	getState(String name)
ArrayList<State>	getStates()
Transition	getTransition(int transitionID)
Transition	getTransition(String name)
int	getTransitionID(String name)	Helper method to get transition ID by name
ArrayList<Transition>	getTransitions()
int	getValidTransitionID(String transName)	Helper method to get transition ID by name
boolean	isCoherent()
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setInitialState(State initialState)
void	setInitialStateCode(int initialStateCode)
void	setStates(ArrayList<State> newStates)
void	setTransitions(ArrayList<Transition> newTransitions)
State	traverse(Activity act, Transition transition, AgentPath agent)
boolean	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cristalise.kernel.utils.DescriptionObject

exists, export, getItemPath, getName, getNamespace, getVersion, getXml, getXml, makeDescCollection, setItemPath, setName, setNamespace, setVersion, toOutcome

Field Details

namespace

public String namespace

name

public String name

version

public Integer version

itemPath

public ItemPath itemPath

Constructor Details

StateMachine

public StateMachine()

StateMachine

public StateMachine(String name,
 Integer version)

Method Details

createState

public State createState(String name)

Factory method to create a new State for the given name. It does NOT check whether the name exists or not

Parameters:

name - the name of the State

Returns:

the new State

createTransition

public Transition createTransition(String name)

Factory method to create a new Transition for the given name. It does NOT check whether the name exists or not

Parameters:

name - the name of the Transition

Returns:

the new Transition

setStates

public void setStates(ArrayList<State> newStates)

setTransitions

public void setTransitions(ArrayList<Transition> newTransitions)

validate

public boolean validate()

getStates

public ArrayList<State> getStates()

getTransitions

public ArrayList<Transition> getTransitions()

getInitialState

public State getInitialState()

setInitialState

public void setInitialState(State initialState)

getInitialStateCode

public int getInitialStateCode()

setInitialStateCode

public void setInitialStateCode(int initialStateCode)

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

getTransition

public Transition getTransition(int transitionID)

getTransition

public Transition getTransition(String name)

getTransitionID

public int getTransitionID(String name)

Helper method to get transition ID by name

Parameters:

name - the name of the Transition

Returns:

the integer ID associated with the Transition name. Returns -1 in case the name does not exist

getValidTransitionID

public int getValidTransitionID(String transName)
                         throws InvalidDataException

Helper method to get transition ID by name

Parameters:

transName - the name of the Transaction

Returns:

the ID matching the name

Throws:

InvalidDataException - the name was not found

getState

public State getState(int stateID)

getState

public State getState(String name)

makeDescCollections

public CollectionArrayList makeDescCollections(TransactionKey transactionKey)

Specified by:

makeDescCollections in interface DescriptionObject

getPossibleTransitions

public List<Transition> getPossibleTransitions(Activity act,
 AgentPath agent)
                                        throws ObjectNotFoundException,
InvalidDataException

Throws:

ObjectNotFoundException

InvalidDataException

traverse

public State traverse(Activity act,
 Transition transition,
 AgentPath agent)
               throws InvalidTransitionException,
AccessRightsException,
ObjectNotFoundException,
InvalidDataException

Throws:

InvalidTransitionException

AccessRightsException

ObjectNotFoundException

InvalidDataException

isCoherent

public boolean isCoherent()

getErrorTransitionIdForState

public int getErrorTransitionIdForState(int id)

getResourceType

public BuiltInResources getResourceType()

Specified by:

getResourceType in interface DescriptionObject

getDefaultStateMachine

public static String getDefaultStateMachine(String type)