com.nosolojava.fsm.runtime

Interface Context

public interface Context

This interface has the current configuration of the FSM: active states, current event, etc.

Author:

Carlos Verdes

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_NAME

Method Summary

Modifier and Type	Method and Description
void	addActiveState(State state)
void	addStateToInvoke(State state)
void	addURLDataHandler(URLDataHandler var)
void	addURLDataHandlers(List<URLDataHandler> vars)
void	clearAndSetURLDataHandlers(List<URLDataHandler> vars)
void	clearStatesToInvoke() Used by the FSM to clear the states to invoke (after invoke them)
void	createVarIfDontExist(String name, Object value)
boolean	evaluateConditionGuardExpresion(String expresion)
void	executeScript(String code)
void	executeScript(URL codeUri)
boolean	existsVarName(String id)
SortedSet<State>	getActiveStates()
Event	getCurrentEvent()
<T> T	getDataByExpression(String expression)
<T> T	getDataByName(String name)
<T> T	getDataFromURL(URL url)
InvokeHandler	getInvokeHandler(String type)
Set<InvokeHandler>	getInvokeHandlers()
Set<IOProcessor>	getIOProcessors()
ContextInstance	getLastStableConfiguration()
StateMachineModel	getModel()
String	getParentSessionId()
IOProcessor	getScxmlIOProcessor()
String	getSessionId()
String	getSessionName()
State	getState(String targetState)
SortedSet<State>	getStatesToInvoke()
boolean	hasExternalEvents()
boolean	hasInternalEvents()
boolean	isActiveState(State state)
boolean	isActiveStateByName(String stateName)
boolean	isInvokeSessionActive(String invokeSessionId) This method is called to check if the invoked session is active.
void	loadDataModel(DataModel dataModel)
void	offerExternalEvent(Event event) Adds an event to the external event queue.
void	offerExternalEvent(String eventName) Adds an event to the external event queue.
void	offerExternalEvent(String eventName, Object data) Adds an event to the external event queue.
void	offerInternalEvent(Event event) Register a new internal event that will be processed by the FSM on the current macrostep.
Event	pollExternalEvent() Retrieves the next external event.
Event	pollInternalEvent()
void	registerInvokeSessionId(String invokeSessionId) When a invoke is executed this method is called to register in the context so any event sent to this invoke session could be managed
void	removeActiveState(State state)
void	removeDatamodel(DataModel dataModel)
void	removeStateToInvoke(State state)
void	saveCurrentConfiguration() The context is a very sensitive part of a FSM session.
IOProcessor	searchIOProcessor(String name) This is used to send/raise events to generate the origin attribute on the event to be sent.
void	setCurrentEvent(Event event)
void	unRegisterInvokeSessionId(String invokeSessionId) When an invoke is canceled then this method is called to avoid the process of more events (to this invoke session).
void	updateData(String id, Object value)
void	updateDataIfExists(String id, Object value)

Field Detail

EVENT_NAME

static final String EVENT_NAME

See Also:

Constant Field Values

Method Detail

saveCurrentConfiguration

void saveCurrentConfiguration()

The context is a very sensitive part of a FSM session. The model, active states, etc. should only be modified by the framework on micro and macro steps.
The FSM framework use this method to save the last stable configuration not exposing internal context.
This protects from outside systems to have incomplete/incongruent configuration and/or to do ilegal modifications on context.

getLastStableConfiguration

ContextInstance getLastStableConfiguration()

Returns:

the last stable configuration, used from outside the fsm session to get access to active states, model data, etc.

getSessionId

String getSessionId()

Returns:

scxml session id. This is used to identify this session by event handlers.

getSessionName

String getSessionName()

Returns:

the session name (the name attribute of the element scxml, for example on the scxml <scxml name="MyStateMachine">...</scxml> this method will return "MyStateMachine".

getParentSessionId

String getParentSessionId()

Returns:

the parent session id if exists, null if there is none.

searchIOProcessor

IOProcessor searchIOProcessor(String name)

This is used to send/raise events to generate the origin attribute on the event to be sent.

Parameters:

name - the type of processor needed (for example http://www.w3.org/TR/scxml/#SCXMLEventProcessor name).

Returns:

the IOProcessor from which the event handler could get the location for this session.

getScxmlIOProcessor

IOProcessor getScxmlIOProcessor()

getIOProcessors

Set<IOProcessor> getIOProcessors()

Returns:

all the processors that are supported

getInvokeHandlers

Set<InvokeHandler> getInvokeHandlers()

Returns:

the invoke handlers registered for this context (FSM config).

getInvokeHandler

InvokeHandler getInvokeHandler(String type)

Parameters:

type - the type of the invoke handler

Returns:

getModel

StateMachineModel getModel()

Returns:

the FSM model (static definition of states, transitions, etc.).

getCurrentEvent

Event getCurrentEvent()

Returns:

the current event.

setCurrentEvent

void setCurrentEvent(Event event)

offerExternalEvent

void offerExternalEvent(String eventName)

Adds an event to the external event queue.

Parameters:

event -

offerExternalEvent

void offerExternalEvent(String eventName,
                        Object data)

Adds an event to the external event queue.

Parameters:

event -

offerExternalEvent

void offerExternalEvent(Event event)

Adds an event to the external event queue.

Parameters:

event -

hasExternalEvents

boolean hasExternalEvents()

pollExternalEvent

Event pollExternalEvent()

Retrieves the next external event. Blocks if empty.

Returns:

hasInternalEvents

boolean hasInternalEvents()

Returns:

true if there is an internal event or more

pollInternalEvent

Event pollInternalEvent()

Returns:

the next internal event. This method doesn't block if empty but hasInternalEvents() method should be used before calling this.

offerInternalEvent

void offerInternalEvent(Event event)

Register a new internal event that will be processed by the FSM on the current macrostep.

Parameters:

event -

registerInvokeSessionId

void registerInvokeSessionId(String invokeSessionId)

When a invoke is executed this method is called to register in the context so any event sent to this invoke session could be managed

Parameters:

invokeSessionId -

unRegisterInvokeSessionId

void unRegisterInvokeSessionId(String invokeSessionId)

When an invoke is canceled then this method is called to avoid the process of more events (to this invoke session).

Parameters:

invokeSessionId -

isInvokeSessionActive

boolean isInvokeSessionActive(String invokeSessionId)

This method is called to check if the invoked session is active.

Parameters:

invokeSessionId -

Returns:

true if the invoke session is active

clearStatesToInvoke

void clearStatesToInvoke()

Used by the FSM to clear the states to invoke (after invoke them)

addStateToInvoke

void addStateToInvoke(State state)

removeStateToInvoke

void removeStateToInvoke(State state)

getStatesToInvoke

SortedSet<State> getStatesToInvoke()

getDataByName

<T> T getDataByName(String name)

getDataByExpression

<T> T getDataByExpression(String expression)

createVarIfDontExist

void createVarIfDontExist(String name,
                          Object value)

updateDataIfExists

void updateDataIfExists(String id,
                        Object value)

existsVarName

boolean existsVarName(String id)

updateData

void updateData(String id,
                Object value)

evaluateConditionGuardExpresion

boolean evaluateConditionGuardExpresion(String expresion)

isActiveStateByName

boolean isActiveStateByName(String stateName)

isActiveState

boolean isActiveState(State state)

getActiveStates

SortedSet<State> getActiveStates()

addActiveState

void addActiveState(State state)

removeActiveState

void removeActiveState(State state)

getDataFromURL

<T> T getDataFromURL(URL url)

addURLDataHandler

void addURLDataHandler(URLDataHandler var)

addURLDataHandlers

void addURLDataHandlers(List<URLDataHandler> vars)

clearAndSetURLDataHandlers

void clearAndSetURLDataHandlers(List<URLDataHandler> vars)

getState

State getState(String targetState)

executeScript

void executeScript(String code)

executeScript

void executeScript(URL codeUri)
            throws IOException

Throws:

IOException

loadDataModel

void loadDataModel(DataModel dataModel)

removeDatamodel

void removeDatamodel(DataModel dataModel)