org.dcs.query_process.model.event

Class Script_Execute

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.event.Script_Execute

Direct Known Subclasses:

Script_Wait

public abstract class Script_Execute
extends Script_Event

This class is for a specific or self-contained type of element that is invoked through the execute method. It should probably have all other parameters already setup, so that it does not need to be configured further by the execution engine.

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

Method Summary

Modifier and Type	Method and Description
abstract boolean	execute() Execute this self-contained script element.
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_Execute

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

Create a new instance of Script_Execute.

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_Execute

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

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

execute

public abstract boolean execute()

Execute this self-contained script element.

Returns:

true if executed OK, false otherwise.

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.