org.dcs.query_process.model.activity

Class Script_Flow

java.lang.Object

org.dcs.query_process.model.Script_Element

org.dcs.query_process.model.data.Script_Conditions

org.dcs.query_process.model.event.Script_Event

org.dcs.query_process.model.activity.Script_Parallel

org.dcs.query_process.model.activity.Script_Flow

public class Script_Flow
extends Script_Parallel

This class stores information on a flow statement, which should contain a number of Script_Event statements as sub-events. A set of parallel activities are evaluated and the best true reply over all replies is used. The true condition returns the effector statement. In this case, the sub-events are of type Script_Case.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.dcs.query_process.model.event.Script_Event

subEvents, varMap

Fields inherited from class org.dcs.query_process.model.data.Script_Conditions

filter, function, operation, source

Fields inherited from class org.dcs.query_process.model.Script_Element

id, internalID, keyLong, name, namespace, objType, parentElement, value

Constructor Summary

Constructors

Constructor and Description
Script_Flow(org.licas_xml.abs.Element autoXml) Create a new instance of Script_Flow and add the xml-based description of the element values.
Script_Flow(java.lang.String scriptType, java.lang.String elemID) Create a new instance of Script_Flow.

Method Summary

Modifier and Type	Method and Description
void	addEvent(Script_Invoke parEvent) Add an event to be run in parallel.
boolean	firstOrBest() Return true if the element should return the first true reply, false if it should return the best true reply.
boolean	processThis() Return true if this specific element contains conditions to evaluate.

Methods inherited from class org.dcs.query_process.model.event.Script_Event

addEvent, addVariable, getEvents, getVariables, setForUse, toXml, usesSubEvents

Methods inherited from class org.dcs.query_process.model.data.Script_Conditions

getFilter, getFunction, getOperation, getSource, setFilter, setFunction, setOperation, setSource

Methods inherited from class org.dcs.query_process.model.Script_Element

getID, getInternalID, getName, getNamespace, getObjType, getParent, getScriptUuid, getValue, setNamespace, setObjType, setParent, setValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Script_Flow

public Script_Flow(java.lang.String scriptType,
                   java.lang.String elemID)

Create a new instance of Script_Flow.

Parameters:

scriptType - the script element type. This is also the element tag name and should not be null.

elemID - this is the external id used to identify this element specifically. The element is also stored under this value and so it cannot be null.

Script_Flow

public Script_Flow(org.licas_xml.abs.Element autoXml)
            throws java.lang.Exception

Create a new instance of Script_Flow and add the xml-based description of the element values.

Parameters:

autoXml - the xml-based description of values to add.

Throws:

java.lang.Exception - any error.

Method Detail

firstOrBest

public boolean firstOrBest()

Return true if the element should return the first true reply, false if it should return the best true reply.

Specified by:

firstOrBest in class Script_Parallel

Returns:

true if a first reply, false if best over all replies.

addEvent

public void addEvent(Script_Invoke parEvent)

Add an event to be run in parallel.

Parameters:

parEvent - the event to add.

processThis

public boolean processThis()

Return true if this specific element contains conditions to evaluate.

Overrides:

processThis in class Script_Element

Returns:

true in this case.