org.da.protoframework.uaappli.script.context

Class UAScriptHelper

java.lang.Object

org.da.protoframework.uaappli.script.context.UAScriptHelper

All Implemented Interfaces:

org.scripthelper.context.ScriptHelper

public class UAScriptHelper
extends java.lang.Object
implements org.scripthelper.context.ScriptHelper

A helper for scripts. It is accessible through the UAScriptContext class and provide several utility methods for the Scripts.

Field Summary

Fields

Modifier and Type	Field and Description
protected UAScriptContext	context

Constructor Summary

Constructors

Constructor and Description
UAScriptHelper() Create the script helper.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getArrayValue(java.lang.String name) Return the data value as an array.
java.util.List<java.lang.Object>	getArrayValue(java.lang.String serviceName, java.lang.String name) Return the data value as an array.
boolean	getBooleanValue(java.lang.String name) Return the value of a Data as a boolean.
boolean	getBooleanValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a boolean.
UAScriptContext	getContext() Return the Script context.
org.da.protoframework.model.core.Data	getData(java.lang.String name) Return the Data of a specified name for the default subscribed Service.
org.da.protoframework.model.core.Data	getData(java.lang.String serviceName, java.lang.String name) Return the Data of a specified name for a specified Service.
float	getFloatValue(java.lang.String name) Return the value of a Data as a float.
float	getFloatValue(java.lang.String name, short unit) Return the value of a Data as a float.
float	getFloatValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a float.
float	getFloatValue(java.lang.String serviceName, java.lang.String name, short unit) Return the value of a Data as a float.
ScriptedFunctionalUA	getFunctionalUA()
int	getIntValue(java.lang.String name) Return the value of a Data as an int.
int	getIntValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as an int.
java.lang.String	getStateValueAsString(java.lang.String name) Return the value of a enumeration state as a String.
java.lang.String	getStateValueAsString(java.lang.String serviceName, java.lang.String name) Return the value of a enumeration state as a String.
java.lang.String	getStringValue(java.lang.String name) Return the value of a Data as a String.
java.lang.String	getStringValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a String.
java.util.List<java.lang.Object>	getStructureValue(java.lang.String name) Return the value of a Data as a structure.
java.lang.Object	getStructureValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a structure.
java.lang.Object	getValue(java.lang.String name) Return the value of a Data.
java.lang.Object	getValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data.
boolean	hasChanged(java.lang.String name) Return true if a Data has changed.
boolean	hasChanged(java.lang.String serviceName, java.lang.String name) Return true if a Data has changed.
void	initialize(UAScriptContext context, ScriptedFunctionalUA ua) Initialize the script helper.
boolean	isStateValue(java.lang.String name, java.lang.String stateAsString) Return true if the value of a enumeration state as a String is equal to a specified String.
boolean	isStateValue(java.lang.String serviceName, java.lang.String name, java.lang.String stateAsString) Return true if the value of a enumeration state as a String is equal to a specified String.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected UAScriptContext context

Constructor Detail

UAScriptHelper

public UAScriptHelper()

Create the script helper.

Method Detail

initialize

public void initialize(UAScriptContext context,
                       ScriptedFunctionalUA ua)

Initialize the script helper.

Parameters:

context - the Script Context

ua - the ScriptedFunctionalUA

getContext

public UAScriptContext getContext()

Return the Script context.

Specified by:

getContext in interface org.scripthelper.context.ScriptHelper

Returns:

the Script context

getFunctionalUA

public ScriptedFunctionalUA getFunctionalUA()

hasChanged

public boolean hasChanged(java.lang.String serviceName,
                          java.lang.String name)

Return true if a Data has changed.

Parameters:

serviceName - the Service name

name - the data name

Returns:

true if the Data has changed

hasChanged

public boolean hasChanged(java.lang.String name)

Return true if a Data has changed.

Parameters:

name - the data name

Returns:

true if the Data has changed

getStateValueAsString

public java.lang.String getStateValueAsString(java.lang.String serviceName,
                                              java.lang.String name)

Return the value of a enumeration state as a String.

Parameters:

serviceName - the Service name

name - the enumeration data name

Returns:

the state value as a String

getStateValueAsString

public java.lang.String getStateValueAsString(java.lang.String name)

Return the value of a enumeration state as a String.

Parameters:

name - the enumeration data name

Returns:

the state value as a String

isStateValue

public boolean isStateValue(java.lang.String serviceName,
                            java.lang.String name,
                            java.lang.String stateAsString)

Return true if the value of a enumeration state as a String is equal to a specified String.

Parameters:

serviceName - the Service name

name - the enumeration data name

stateAsString - the requested state value as a String

Returns:

true if the value of a enumeration state as a String is equal to the specified String

isStateValue

public boolean isStateValue(java.lang.String name,
                            java.lang.String stateAsString)

Return true if the value of a enumeration state as a String is equal to a specified String.

Parameters:

name - the enumeration data name

stateAsString - the requested state value as a String

Returns:

true if the value of a enumeration state as a String is equal to the specified String

getData

public org.da.protoframework.model.core.Data getData(java.lang.String name)

Return the Data of a specified name for the default subscribed Service.

Parameters:

name - the Data name

Returns:

the Data

getData

public org.da.protoframework.model.core.Data getData(java.lang.String serviceName,
                                                     java.lang.String name)

Return the Data of a specified name for a specified Service.

Parameters:

serviceName - the Service name

name - the Data name

Returns:

the Data

getArrayValue

public java.util.List<java.lang.Object> getArrayValue(java.lang.String serviceName,
                                                      java.lang.String name)

Return the data value as an array.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the value

getArrayValue

public java.util.List<java.lang.Object> getArrayValue(java.lang.String name)

Return the data value as an array.

Parameters:

name - the data name

Returns:

the value

getValue

public java.lang.Object getValue(java.lang.String name)

Return the value of a Data.

Parameters:

name - the data name

Returns:

the data value

getValue

public java.lang.Object getValue(java.lang.String serviceName,
                                 java.lang.String name)

Return the value of a Data.

Parameters:

serviceName - the service name

name - the data name

Returns:

the data value

getStructureValue

public java.util.List<java.lang.Object> getStructureValue(java.lang.String name)

Return the value of a Data as a structure.

Parameters:

name - the data name

Returns:

the data value

getStructureValue

public java.lang.Object getStructureValue(java.lang.String serviceName,
                                          java.lang.String name)

Return the value of a Data as a structure.

Parameters:

serviceName - the service name

name - the data name

Returns:

the data value

getIntValue

public int getIntValue(java.lang.String serviceName,
                       java.lang.String name)

Return the value of a Data as an int.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as an int

getIntValue

public int getIntValue(java.lang.String name)

Return the value of a Data as an int.

Parameters:

name - the data name

Returns:

the data value as an int

getFloatValue

public float getFloatValue(java.lang.String serviceName,
                           java.lang.String name)

Return the value of a Data as a float.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String serviceName,
                           java.lang.String name,
                           short unit)

Return the value of a Data as a float.

Parameters:

serviceName - the Service name

name - the data name

unit - the unit

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String name)

Return the value of a Data as a float.

Parameters:

name - the data name

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String name,
                           short unit)

Return the value of a Data as a float.

Parameters:

name - the data name

unit - the unit

Returns:

the data value as a float

getBooleanValue

public boolean getBooleanValue(java.lang.String serviceName,
                               java.lang.String name)

Return the value of a Data as a boolean.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a boolean

getBooleanValue

public boolean getBooleanValue(java.lang.String name)

Return the value of a Data as a boolean.

Parameters:

name - the data name

Returns:

the data value as a boolean

getStringValue

public java.lang.String getStringValue(java.lang.String serviceName,
                                       java.lang.String name)

Return the value of a Data as a String.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a String

getStringValue

public java.lang.String getStringValue(java.lang.String name)

Return the value of a Data as a String.

Parameters:

name - the data name

Returns:

the data value as a String