org.dcs.query_process.model

Class Script_Model

java.lang.Object

org.dcs.query_process.model.Script_Element

org.dcs.query_process.model.Script_Model

Direct Known Subclasses:

Script_Process

public abstract class Script_Model
extends Script_Element

This class stores all of the elements that are used to create an auto engine script.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,Script_Source>	sources List of sources.

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

Method Summary

Modifier and Type	Method and Description
void	addEvent(Script_Event theEvent) Add an event to the model.
boolean	addReflection(Script_Reflection theReflection) Add a reflection instance to the model.
boolean	addSource(Script_Source theSource) Add a source to the model.
boolean	addVariable(Script_Variable theVariable) Add a variable to the model.
boolean	addVariableInstance(Script_VariableInstance theVariableInstance) Add a variable instance to the model.
java.util.ArrayList<Script_Event>	getEvents() Get the model events.
java.util.HashMap<java.lang.String,Script_Reflection>	getReflection() Get the model reflection instances.
Script_Reflection	getReflection(java.lang.String variableName) Get the model reflection instance.
Script_Element	getScriptWithID(java.lang.String scriptID) Get the script element with the specified id.
Script_Source	getSource(java.lang.String sourceName) Get the model source.
java.util.HashMap<java.lang.String,Script_Source>	getSources() Get the model sources.
Script_Variable	getVariable(java.lang.String variableName) Get the model variable.
Script_VariableInstance	getVariableInstance(java.lang.String variableName) Get the model variable instance.
java.util.HashMap<java.lang.String,Script_VariableInstance>	getVariableInstances() Get the model variable instances.
java.util.HashMap<java.lang.String,Script_Variable>	getVariables() Get the model variables.
void	setEvents(java.util.ArrayList<Script_Event> theEvents) Set the model events.
java.util.HashMap<java.lang.String,Script_Element>	setForUse() Initialise the script model to be used.
void	setReflection(java.util.HashMap<java.lang.String,Script_Reflection> theReflection) Set the model reflection set.
void	setSources(java.util.HashMap<java.lang.String,Script_Source> theSources) Set the model variables.
void	setVariableInstances(java.util.HashMap<java.lang.String,Script_VariableInstance> theVariableInstances) Set the model variable instances.
void	setVariables(java.util.HashMap<java.lang.String,Script_Variable> theVariables) Set the model variables.
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.Script_Element

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

Methods inherited from class java.lang.Object

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

Field Detail

sources

public java.util.HashMap<java.lang.String,Script_Source> sources

List of sources. Key is element id and value is of type Script_Source.

Constructor Detail

Script_Model

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

Create a new instance of Script_Model.

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_Model

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

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

setEvents

public void setEvents(java.util.ArrayList<Script_Event> theEvents)

Set the model events. This is equivalent to a BPEL activity.

Parameters:

theEvents - the events. Of type Script_Event.

addEvent

public void addEvent(Script_Event theEvent)

Add an event to the model. This is equivalent to a BPEL activity, but can be of different types.

Parameters:

theEvent - the event to add.

getEvents

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

Get the model events. This is equivalent to a BPEL activity.

Returns:

the value of events.

setSources

public void setSources(java.util.HashMap<java.lang.String,Script_Source> theSources)

Set the model variables.

Parameters:

theSources - the model sources. Keys are the variable names while values are of type Script_Source.

addSource

public boolean addSource(Script_Source theSource)

Add a source to the model.

Parameters:

theSource - the variable to add.

Returns:

true if the variable is added or false if the variable name already exists.

getSource

public Script_Source getSource(java.lang.String sourceName)

Get the model source.

Parameters:

sourceName - the name of the variable to return.

Returns:

the variable with the specified name, or null if it does not exist.

getSources

public java.util.HashMap<java.lang.String,Script_Source> getSources()

Get the model sources.

Returns:

the value of sources.

setVariables

public void setVariables(java.util.HashMap<java.lang.String,Script_Variable> theVariables)

Set the model variables.

Parameters:

theVariables - the model variables. Keys are the variable names while values are of type Script_Variable.

addVariable

public boolean addVariable(Script_Variable theVariable)

Add a variable to the model.

Parameters:

theVariable - the variable to add.

Returns:

true if the variable is added or false if the variable name already exists.

getVariable

public Script_Variable getVariable(java.lang.String variableName)

Get the model variable.

Parameters:

variableName - the name of the variable to return.

Returns:

the variable with the specified name, or null if it does not exist.

getVariables

public java.util.HashMap<java.lang.String,Script_Variable> getVariables()

Get the model variables.

Returns:

the value of variables.

setVariableInstances

public void setVariableInstances(java.util.HashMap<java.lang.String,Script_VariableInstance> theVariableInstances)

Set the model variable instances.

Parameters:

theVariableInstances - the model variables. Keys are the variable names while values are of type Script_VariableInstance.

addVariableInstance

public boolean addVariableInstance(Script_VariableInstance theVariableInstance)

Add a variable instance to the model.

Parameters:

theVariableInstance - the variable instance to add.

Returns:

true if the variable is added or false if the variable name already exists.

getVariableInstance

public Script_VariableInstance getVariableInstance(java.lang.String variableName)

Get the model variable instance.

Parameters:

variableName - the name of the variable to return.

Returns:

the variable with the specified name, or null if it does not exist.

getVariableInstances

public java.util.HashMap<java.lang.String,Script_VariableInstance> getVariableInstances()

Get the model variable instances.

Returns:

the value of varInstances.

setReflection

public void setReflection(java.util.HashMap<java.lang.String,Script_Reflection> theReflection)

Set the model reflection set.

Parameters:

theReflection - the list of reflection descriptions. Keys are the variable/method ids/names while values are of type Script_Reflection.

addReflection

public boolean addReflection(Script_Reflection theReflection)

Add a reflection instance to the model.

Parameters:

theReflection - the reflection instance to add.

Returns:

true if the variable is added or false if the variable name already exists.

getReflection

public Script_Reflection getReflection(java.lang.String variableName)

Get the model reflection instance.

Parameters:

variableName - the name of the variable to return.

Returns:

the variable with the specified name, or null if it does not exist.

getReflection

public java.util.HashMap<java.lang.String,Script_Reflection> getReflection()

Get the model reflection instances.

Returns:

the value of reflection.

getScriptWithID

public Script_Element getScriptWithID(java.lang.String scriptID)

Get the script element with the specified id.

Parameters:

scriptID - the id of the element to look for. Retrieve from the entity map.

Returns:

the script element or null if one does not exist.

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_Element

Returns:

the contents as an XML-based description only.

Throws:

java.lang.Exception - any error.