Package com.aquima.interactions.flow.model

Class FreeFlowEvaluator

java.lang.Object

com.aquima.interactions.flow.model.FreeFlowEvaluator

public class FreeFlowEvaluator
extends Object

Flow evaluator which can evaluate a flow.

This class holds data which is available during an evaluate action.

Since:

16.6

Author:

O. de Groote

Field Summary

Fields

Modifier and Type	Field	Description
protected InternalNode	currentNode
protected ExitEvent	exitEvent
protected ExitState	exitState
protected final FlowEngine	flowEngine
protected final IFlowHandler	flowHandler
protected FlowPath	flowPath
static final String	GO_TO_PAGE_EXIT_EVENT
protected final FlowNodeCounter	nodeCounter
protected FlowNodeException	nodeException
protected final Stack<RepeatState>	repeatStates

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FreeFlowEvaluator(FlowEngine engine, IFlowHandler handler, IFlowState fs, IFlowDebugger debugger)
protected	FreeFlowEvaluator(FlowEngine engine, IFlowHandler handler, IFlowState fs, IFlowDebugger debugger, FlowNodeCounter nodeCounter)

Method Summary

Modifier and Type	Method	Description
protected InternalEdge	chooseEdge(ExitEvent exitEvent)	Based on the event, this method selects the edge to follow from the current node
IFlowState	continueEvaluation()
IFlowState	continueEvaluation(ExitEvent pageEvent)
protected IFlowState	createFlowState()
IFlowState	evaluateFlow(InternalFlow flow)
protected RepeatState	getRepeatState()
protected void	processEnd(InternalNode endNode)
protected void	resumeParentNode(String currentFlowName, IEndNodeDetails endNodeDetails)	defines how to resume a parent flow after an end-node
IFlowState	revertToFlow(String flowName)
protected void	setCurrentNode(InternalNode internalNode, ExitEvent exitEvent)	sets all relevant data when updating currentNode value

Methods inherited from class java.lang.Object

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

Field Details

GO_TO_PAGE_EXIT_EVENT

public static final String GO_TO_PAGE_EXIT_EVENT

See Also:

• Constant Field Values

flowEngine

protected final FlowEngine flowEngine

flowHandler

protected final IFlowHandler flowHandler

nodeCounter

protected final FlowNodeCounter nodeCounter

repeatStates

protected final Stack<RepeatState> repeatStates

flowPath

protected FlowPath flowPath

currentNode

protected InternalNode currentNode

exitEvent

protected ExitEvent exitEvent

exitState

protected ExitState exitState

nodeException

protected FlowNodeException nodeException

Constructor Details

FreeFlowEvaluator

protected FreeFlowEvaluator(FlowEngine engine,
 IFlowHandler handler,
 IFlowState fs,
 IFlowDebugger debugger)

FreeFlowEvaluator

protected FreeFlowEvaluator(FlowEngine engine,
 IFlowHandler handler,
 IFlowState fs,
 IFlowDebugger debugger,
 FlowNodeCounter nodeCounter)

Method Details

createFlowState

protected IFlowState createFlowState()

chooseEdge

protected InternalEdge chooseEdge(ExitEvent exitEvent)

Based on the event, this method selects the edge to follow from the current node

Parameters:

exitEvent - , cannot be null

Returns:

InternalEdge, can be null

resumeParentNode

protected void resumeParentNode(String currentFlowName,
 IEndNodeDetails endNodeDetails)

defines how to resume a parent flow after an end-node

Parameters:

currentFlowName - flow name containing the end-node

endNodeDetails - IEndNodeDetails, cannot be null

evaluateFlow

public IFlowState evaluateFlow(InternalFlow flow)

continueEvaluation

public IFlowState continueEvaluation(ExitEvent pageEvent)

continueEvaluation

public IFlowState continueEvaluation()

revertToFlow

public IFlowState revertToFlow(String flowName)

processEnd

protected void processEnd(InternalNode endNode)
                   throws UnknownFlowException,
InfiniteFlowException,
FlowNodeException

Throws:

UnknownFlowException

InfiniteFlowException

FlowNodeException

setCurrentNode

protected void setCurrentNode(InternalNode internalNode,
 ExitEvent exitEvent)

sets all relevant data when updating currentNode value

Parameters:

internalNode - new value for current node, cannot be null

exitEvent - exitEvent used to determine new current node

getRepeatState

protected RepeatState getRepeatState()