org.dcs.query_process.model.data

Class Script_Conditions

java.lang.Object

org.dcs.query_process.model.Script_Element

org.dcs.query_process.model.data.Script_Conditions

Direct Known Subclasses:

Script_Event

public abstract class Script_Conditions
extends Script_Element

This class stores an attribute set that other elements might use. If used in full, it stores a function to be evaluated during the script execution process that can be used to define when the script repeats or when it moves to the next process phase.

The function variable itself defines the evaluation requirement. This can be a boolean result or a mathematical comparison. The String-based representation is of the form method_name:operator, where the method name is the key name to the method to use, from the Script_Model.Reflection section. For a boolean evaluation, set the comparison operator to Boolean.TRUE or FALSE. For a mathematical comparison, set the operator to AiHeuristicConst.EQ, GT, LE and so on. The evaluation is then carried out as:
Use source.method to evaluate input and compare as true with filter based on the operator.

If any value is null then it is simply not added to the script and so the function set can be used simply to define a single variable, for example.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filter A filter applied to the method result
protected org.ai_heuristic.eval.Condition	function Additional evaluation function on the method result or filter.
protected java.lang.String	operation The operation or method to invoke
protected java.lang.String	source The source variable to execute the function on

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilter() Get the output filter.
org.ai_heuristic.eval.Condition	getFunction() Get the comparison function.
java.lang.String	getOperation() Get the operation to be invoked.
java.lang.String	getSource() Get the source id.
void	setFilter(java.lang.String theFilter) Set the filter on the operation result.
void	setFunction(org.ai_heuristic.eval.Condition theFunction) Set the function that evaluates the result further.
void	setOperation(java.lang.String thisOperation) Set the operation to be invoked.
void	setSource(java.lang.String theSource) Set the source to execute the function on.
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, 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

Field Detail

operation

protected java.lang.String operation

The operation or method to invoke

filter

protected java.lang.String filter

A filter applied to the method result

function

protected org.ai_heuristic.eval.Condition function

Additional evaluation function on the method result or filter. May check for 'true' or exists, or can be math comparison.

source

protected java.lang.String source

The source variable to execute the function on

Constructor Detail

Script_Conditions

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

Create a new instance of Script_Conditions.

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_Conditions

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

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

setOperation

public void setOperation(java.lang.String thisOperation)

Set the operation to be invoked.

Parameters:

thisOperation - the operation name.

getOperation

public java.lang.String getOperation()

Get the operation to be invoked.

Returns:

the value of operation.

setFilter

public void setFilter(java.lang.String theFilter)

Set the filter on the operation result.

Parameters:

theFilter - a filter (query, for example) to apply on the operation result.

getFilter

public java.lang.String getFilter()

Get the output filter.

Returns:

the value of filter.

setFunction

public void setFunction(org.ai_heuristic.eval.Condition theFunction)

Set the function that evaluates the result further.

Parameters:

theFunction - the comparison function.

getFunction

public org.ai_heuristic.eval.Condition getFunction()

Get the comparison function.

Returns:

the value of function.

setSource

public void setSource(java.lang.String theSource)

Set the source to execute the function on.

Parameters:

theSource - the function source.

getSource

public java.lang.String getSource()

Get the source id.

Returns:

the value of source.

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.