org.dcs.query_process.model.data

Class Script_VarMap

java.lang.Object

org.dcs.query_process.model.Script_Element

org.dcs.query_process.model.data.Script_VariableInstance

org.dcs.query_process.model.data.Script_VarMap

public class Script_VarMap
extends Script_VariableInstance

This class stores information on a set of variable values stored as key-value pairs.

Author:

Kieran Greer

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	addValue(java.lang.String varName, java.lang.String value) Add a new key-value pair.
java.lang.Object	getValue() Get the VarMap value.
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, processThis, setForUse, setNamespace, setObjType, setParent, setValue, setValue, usesSubEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Script_VarMap

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

Create a new instance of Script_VarMap.

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_VarMap

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

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

addValue

public void addValue(java.lang.String varName,
                     java.lang.String value)

Add a new key-value pair. This overwrites any existing entry.

Parameters:

varName - the variable name the value is for.

value - the variable value.

getValue

public java.lang.Object getValue()

Get the VarMap value. This returns the variable-value hashtable.

Overrides:

getValue in class Script_Element

Returns:

the value of varMap;

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.