org.dcs.query_process.model.event

Class Script_Event

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

Direct Known Subclasses:

Script_Auto, Script_Case, Script_Execute, Script_Invoke, Script_Link, Script_Parallel, Script_Sequence, Script_Switch, Script_WhileLoop

public abstract class Script_Event
extends Script_Conditions

An event is the definition of a basic activity of the script process. The base type for all events is Script_Event, but it can be of any derived type.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<Script_Event>	subEvents List of sub-events.
protected java.util.ArrayList<Script_Variable>	varMap List of variable names to map to instances in the method.

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

Method Summary

Modifier and Type	Method and Description
void	addEvent(Script_Event subEvent) Add a sub-event to this event.
void	addVariable(Script_Variable var) Add a variable mapping.
java.util.ArrayList<Script_Event>	getEvents() Retrieve the list of sub-events of this event.
java.util.ArrayList<Script_Variable>	getVariables() Retrieve the list of sub-events of this event.
java.util.HashMap<java.lang.String,Script_Element>	setForUse() Initialise the script model to be used.
org.licas_xml.abs.Element	toXml() Convert the contents of this Script_Element into an XML-only format.
boolean	usesSubEvents() Return true if the script element can have sub-events.

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

Field Detail

subEvents

protected java.util.ArrayList<Script_Event> subEvents

List of sub-events. This can be in sequence or in parallel.

varMap

protected java.util.ArrayList<Script_Variable> varMap

List of variable names to map to instances in the method. The ID is the method parameter name and the text value is the key for the variable replacement.

Constructor Detail

Script_Event

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

Create a new instance of Script_Event.

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_Event

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

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

setForUse

public java.util.HashMap<java.lang.String,Script_Element> setForUse()

Initialise the script model to be used. This includes creating the map of ids to entity descriptions and also adding all parent references.

Overrides:

setForUse in class Script_Element

Returns:

the entity map for this script part.

usesSubEvents

public boolean usesSubEvents()

Return true if the script element can have sub-events.

Overrides:

usesSubEvents in class Script_Element

Returns:

false here, only true for event elements.

addEvent

public void addEvent(Script_Event subEvent)

Add a sub-event to this event.

Parameters:

subEvent - the sub-event to add.

getEvents

public java.util.ArrayList<Script_Event> getEvents()

Retrieve the list of sub-events of this event.

Returns:

the value of usesSubEvents.

addVariable

public void addVariable(Script_Variable var)

Add a variable mapping. ID is also the parameter name.

Parameters:

var - the variable mapping.

getVariables

public java.util.ArrayList<Script_Variable> getVariables()

Retrieve the list of sub-events of this event.

Returns:

the value of usesSubEvents.

toXml

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

Convert the contents of this Script_Element into an XML-only format.

Overrides:

toXml in class Script_Conditions

Returns:

the contents as an XML-based description only.

Throws:

java.lang.Exception - any error.