org.dcs.query_process.model

Class Script_Element

java.lang.Object

org.dcs.query_process.model.Script_Element

Direct Known Subclasses:

Script_Conditions, Script_Model, Script_Reflection, Script_Source, Script_Variable, Script_VariableInstance

public class Script_Element
extends java.lang.Object

Base element component for the Auto or BPEL script elements.

Author:

Kieran Greer.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id An external unique identifier, so that the element can be referenced by other elements
protected java.lang.String	internalID Unique internal identifier
static long	keyLong For generating a unique key value
protected java.lang.String	name The element name
protected java.lang.String	namespace The target namespace
protected java.lang.String	objType The Object type the script element relates to
protected Script_Element	parentElement The parent element of this one
protected java.lang.Object	value The element value, which can be text or an element.

Constructor Summary

Constructors

Constructor and Description
Script_Element(org.licas_xml.abs.Element autoXml) Create a new instance of Script_Element and add the xml-based description of the element values.
Script_Element(java.lang.String scriptType, java.lang.String elemID) Create a new instance of Script_Element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getID() Get the external unique identifier, so that the element can be referenced by other elements.
java.lang.String	getInternalID() Get the internal id value that uniquely identifies this process part.
java.lang.String	getName() Get the name of this element, similar to an XML tag name and should identify its type.
java.lang.String	getNamespace() Get the target namespace of this element.
java.lang.String	getObjType() Get the object type the script element relates to.
Script_Element	getParent() Get the parent element.
protected static java.lang.String	getScriptUuid() Create and return a unique uuid.
java.lang.Object	getValue() Get the element value.
boolean	processThis() Return true if this specific element contains conditions to evaluate.
java.util.HashMap<java.lang.String,Script_Element>	setForUse() Initialise the script model to be used.
void	setNamespace(java.lang.String thisNamespace) Set the target namespace for this element.
void	setObjType(java.lang.String thisObjType) Set the object type the script element relates to.
void	setParent(Script_Element parent) Set the parent element.
void	setValue(java.lang.Object thisValue) Set the element value.
void	setValue(java.lang.Object thisValue, org.licas_xml.abs.Element addTo) Set the element value in the XML element.
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 java.lang.Object

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

Field Detail

keyLong

public static long keyLong

For generating a unique key value

name

protected java.lang.String name

The element name

namespace

protected java.lang.String namespace

The target namespace

id

protected java.lang.String id

An external unique identifier, so that the element can be referenced by other elements

internalID

protected java.lang.String internalID

Unique internal identifier

objType

protected java.lang.String objType

The Object type the script element relates to

value

protected java.lang.Object value

The element value, which can be text or an element. Can be null.

parentElement

protected Script_Element parentElement

The parent element of this one

Constructor Detail

Script_Element

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

Create a new instance of Script_Element.

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_Element

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

Create a new instance of Script_Element 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. The default is false, so you need to override this method to change the condition.

Returns:

true if the element contains evaluation conditions, false otherwise.

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.

Returns:

the entity map for this script part. Default is just this element.

usesSubEvents

public boolean usesSubEvents()

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

Returns:

false here, only true for event elements.

getName

public java.lang.String getName()

Get the name of this element, similar to an XML tag name and should identify its type.

Returns:

the value of name.

setNamespace

public void setNamespace(java.lang.String thisNamespace)

Set the target namespace for this element.

Parameters:

thisNamespace - the ontology namespace.

getNamespace

public java.lang.String getNamespace()

Get the target namespace of this element.

Returns:

the value of namespace.

getID

public java.lang.String getID()

Get the external unique identifier, so that the element can be referenced by other elements.

Returns:

the value of id.

getInternalID

public java.lang.String getInternalID()

Get the internal id value that uniquely identifies this process part.

Returns:

the value of internalID.

setObjType

public void setObjType(java.lang.String thisObjType)

Set the object type the script element relates to.

Parameters:

thisObjType - reference to the type of actual object.

getObjType

public java.lang.String getObjType()

Get the object type the script element relates to.

Returns:

the value of objType. Can be null.

setValue

public void setValue(java.lang.Object thisValue,
                     org.licas_xml.abs.Element addTo)

Set the element value in the XML element.

Parameters:

thisValue - the element value, either a text or an XML element value.

addTo - the xml element to add the value to.

setValue

public void setValue(java.lang.Object thisValue)

Set the element value.

Parameters:

thisValue - the element value.

getValue

public java.lang.Object getValue()

Get the element value.

Returns:

the value of value. Can be null.

setParent

public void setParent(Script_Element parent)

Set the parent element.

Parameters:

parent - the parent script element.

getParent

public Script_Element getParent()

Get the parent element.

Returns:

the value of parentElement.

toXml

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

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

Returns:

the contents as an XML-based description only.

Throws:

java.lang.Exception - any error.

getScriptUuid

protected static java.lang.String getScriptUuid()

Create and return a unique uuid.

Returns:

a unique value to be used as an id.