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 and Description
ItemPath	itemPath
String	name
Integer	version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
void	export(Writer imports, File dir, boolean shallow)
int	getErrorTransitionIdForState(int id)
State	getInitialState()
int	getInitialStateCode()
String	getItemID()
ItemPath	getItemPath()
String	getName()
Map<Transition,String>	getPossibleTransitions(Activity act, AgentPath agent)
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
Integer	getVersion()
boolean	isCoherent()
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setInitialState(State initialState)
void	setInitialStateCode(int initialStateCode)
void	setItemPath(ItemPath path)
void	setName(String name)
void	setStates(ArrayList<State> newStates)
void	setTransitions(ArrayList<Transition> newTransitions)
void	setVersion(Integer version)
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

Field Detail

name

public String name

version

public Integer version

itemPath

public ItemPath itemPath

Constructor Detail

StateMachine

public StateMachine()

StateMachine

public StateMachine(String name,
                    Integer version)

Method Detail

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)

getName

public String getName()

Specified by:

getName in interface DescriptionObject

getVersion

public Integer getVersion()

Specified by:

getVersion in interface DescriptionObject

setName

public void setName(String name)

Specified by:

setName in interface DescriptionObject

setVersion

public void setVersion(Integer version)

Specified by:

setVersion in interface DescriptionObject

getItemPath

public ItemPath getItemPath()

Specified by:

getItemPath in interface DescriptionObject

setItemPath

public void setItemPath(ItemPath path)

Specified by:

setItemPath in interface DescriptionObject

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 Map<Transition,String> 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)

export

public void export(Writer imports,
                   File dir,
                   boolean shallow)
            throws IOException,
                   InvalidDataException

Specified by:

export in interface DescriptionObject

Throws:

IOException

InvalidDataException