org.dcs.query_process.model.event

Class Script_Invoke

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_Invoke

public class Script_Invoke
extends Script_Event

This class stores information on a event invoke statement. The target link is stored as a sub-event.

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

Method Summary

Modifier and Type	Method and Description
boolean	processThis() Return true if this specific element contains conditions to evaluate.
java.util.HashMap	setForUse() Initialise the script model to be used.
void	setLink(Script_Link theLink) Set the link for this event.
org.licas_xml.abs.Element	toXml() Convert the contents of this Script_Element into an XML-only format.

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

addEvent, addVariable, getEvents, getVariables, 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_Invoke

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

Create a new instance of Script_Invoke.

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_Invoke

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

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

processThis

public boolean processThis()

Return true if this specific element contains conditions to evaluate.

Overrides:

processThis in class Script_Element

Returns:

true for this element.

setForUse

public java.util.HashMap 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_Event

Returns:

the entity map for this script part.

setLink

public void setLink(Script_Link theLink)

Set the link for this event. Stored as a sub-event.

Parameters:

theLink - the link to invoke.

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_Event

Returns:

the contents as an XML-based description only.

Throws:

java.lang.Exception - any error.