org.dcs.query_process.model.activity

Class Script_SwitchTrue

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_Switch

org.dcs.query_process.model.activity.Script_SwitchTrue

public class Script_SwitchTrue
extends Script_Switch

This class extends the Script_Switch to be specifically for true case results only. Each sub-event is executed in sequence until a true Condition result is realised. The effector for that true result is then returned to the program. This specific case has added methods to allow you to add the sub-event Script_Case statements automatically and will set some of the case values.

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_SwitchTrue(org.licas_xml.abs.Element autoXml) Create a new instance of Script_Switch and add the xml-based description of the element values.
Script_SwitchTrue(java.lang.String scriptType, java.lang.String elemID) Create a new instance of Script_Switch.

Method Summary

Modifier and Type	Method and Description
Script_Case	addCase(java.lang.String source, java.lang.String operation, Script_Variable vars, java.lang.String filter, Script_Event effector) Create and add a new case statement to this switch statement.

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, processThis, 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_SwitchTrue

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

Create a new instance of Script_Switch.

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_SwitchTrue

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

Create a new instance of Script_Switch 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

addCase

public Script_Case addCase(java.lang.String source,
                           java.lang.String operation,
                           Script_Variable vars,
                           java.lang.String filter,
                           Script_Event effector)
                    throws java.lang.Exception

Create and add a new case statement to this switch statement. Automatically set the case ID and the evaluation condition to true. The other values can be passed in as parameters or set later in the returned case statement. So any parameter can be null here and set later.

Overrides:

addCase in class Script_Switch

Parameters:

source - reference to the source to execute the operation on.

operation - name of the method or operation to execute for the case.

vars - variable(s) that the operation might use.

filter - filter reference to filter any operation reply with.

effector - return this effector event if the case statement is true.

Returns:

the case statement that is created.

Throws:

java.lang.Exception - any error.