org.da.protoframework.model.core

Class Datas

java.lang.Object

org.da.protoframework.model.core.Datas

All Implemented Interfaces:

java.lang.Cloneable

public class Datas
extends java.lang.Object
implements java.lang.Cloneable

The datas for one application and one Service.

Constructor Summary

Constructors

Constructor and Description
Datas(Service<?> service) Constructor.

Method Summary

Modifier and Type	Method and Description
Datas	clone()
void	copyFrom(java.util.Map<java.lang.String,Data<?>> origin) Copy the Datas from another Datas.
Data<?>	getData(java.lang.String name) Return the Service Datas.
Data.Array	getDataAsArray(java.lang.String name) Return the Data of a specified name, as an array. it will return null if the Data is not an array.
Data.MapData	getDataAsMap(java.lang.String name) Return the Data of a specified name, as a Map. it will return null if the Data is not a Map.
Data.Structure	getDataAsStructure(java.lang.String name) Return the Data of a specified name, as a structure. it will return null if the Data is not a structure.
Data.Switch	getDataAsSwitch(java.lang.String name) Return the Data of a specified name, as a Switch. it will return null if the Data is not a switch.
Data.Union	getDataAsUnion(java.lang.String name) Return the Data of a specified name, as an Union. it will return null if the Data is not an Union.
java.util.Map<java.lang.String,Data<?>>	getDatas() Return the map of datas.
static Datas	getEmptyDatas() Return an empty Data list, which contains no Data.
Service<?>	getService() Return the Service.
boolean	hasChanged(java.lang.String name) Return true if the Data with a specified name has changed since the last reception.
boolean	hasData(java.lang.String name) Return true if the Service has a Data of a specified name.
short	setDataBooleanValue(java.lang.String name, boolean value) Set the boolean value of a Data.
short	setDataByteValue(java.lang.String name, byte value) Set the byte value of a Data.
short	setDataCharValue(java.lang.String name, char value) Set the char value of a Data.
short	setDataDoubleValue(java.lang.String name, double value) Set the double value of a Data.
short	setDataDoubleValue(java.lang.String name, double value, short unit) Set the double value of a Data.
short	setDataFileValue(java.lang.String name, java.io.File value) Set a File Data value.
short	setDataFloatValue(java.lang.String name, float value) Set the float value of a Data.
short	setDataFloatValue(java.lang.String name, float value, short unit) Set the float value of a Data.
short	setDataIntValue(java.lang.String name, int value) Set the int value of a Data.
short	setDataJSONValue(java.lang.String name, org.json.JSONElement value) Set the JSON value of a Data as a JSONElement.
short	setDataLongValue(java.lang.String name, long value) Set the long value of a Data.
short	setDataShortValue(java.lang.String name, short value) Set the short value of a Data.
short	setDataStringValue(java.lang.String name, java.lang.String value) Set the String value of a Data.
short	setDataURLValue(java.lang.String name, java.net.URL value) Set the value of a Data as an URL.
short	setDataValue(java.lang.String name, java.lang.Object value) Set the value of a Data.
short	setDataXMLValue(java.lang.String name, org.mdiutil.xml.tree.XMLNode value) Set the XML value of a Data as an XMLNode.
void	setup() Setup the Datas.

Methods inherited from class java.lang.Object

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

Constructor Detail

Datas

public Datas(Service<?> service)

Constructor.

Parameters:

service - the Service

Method Detail

getEmptyDatas

public static Datas getEmptyDatas()

Return an empty Data list, which contains no Data.

Returns:

an empty Data list

getService

public Service<?> getService()

Return the Service.

Returns:

the Service

getDatas

public java.util.Map<java.lang.String,Data<?>> getDatas()

Return the map of datas.

Returns:

the map of datas

copyFrom

public void copyFrom(java.util.Map<java.lang.String,Data<?>> origin)

Copy the Datas from another Datas.

Parameters:

origin - the origin Datas

clone

public Datas clone()
            throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setup

public void setup()

Setup the Datas.

setDataValue

public short setDataValue(java.lang.String name,
                          java.lang.Object value)

Set the value of a Data.

Parameters:

name - the Data name

value - the Data value

Returns:

true if the Data value could be set

setDataIntValue

public short setDataIntValue(java.lang.String name,
                             int value)

Set the int value of a Data.

Parameters:

name - the Data name

value - the Data int value

Returns:

true if the Data value could be set

setDataByteValue

public short setDataByteValue(java.lang.String name,
                              byte value)

Set the byte value of a Data.

Parameters:

name - the Data name

value - the Data byte value

Returns:

true if the Data value could be set

setDataLongValue

public short setDataLongValue(java.lang.String name,
                              long value)

Set the long value of a Data.

Parameters:

name - the Data name

value - the Data long value

Returns:

true if the Data value could be set

setDataCharValue

public short setDataCharValue(java.lang.String name,
                              char value)

Set the char value of a Data.

Parameters:

name - the Data name

value - the Data char value

Returns:

true if the Data value could be set

setDataShortValue

public short setDataShortValue(java.lang.String name,
                               short value)

Set the short value of a Data.

Parameters:

name - the Data name

value - the Data short value

Returns:

true if the Data value could be set

setDataFloatValue

public short setDataFloatValue(java.lang.String name,
                               float value)

Set the float value of a Data.

Parameters:

name - the Data name

value - the Data float value

Returns:

true if the Data value could be set

setDataFloatValue

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

Set the float value of a Data.

Parameters:

name - the Data name

value - the Data float value

unit - the unit

Returns:

true if the Data value could be set

setDataDoubleValue

public short setDataDoubleValue(java.lang.String name,
                                double value)

Set the double value of a Data.

Parameters:

name - the Data name

value - the Data double value

Returns:

true if the Data value could be set

setDataDoubleValue

public short setDataDoubleValue(java.lang.String name,
                                double value,
                                short unit)

Set the double value of a Data.

Parameters:

name - the Data name

value - the Data double value

unit - the unit

Returns:

true if the Data value could be set

setDataBooleanValue

public short setDataBooleanValue(java.lang.String name,
                                 boolean value)

Set the boolean value of a Data.

Parameters:

name - the Data name

value - the Data boolean value

Returns:

true if the Data value could be set

setDataStringValue

public short setDataStringValue(java.lang.String name,
                                java.lang.String value)

Set the String value of a Data.

Parameters:

name - the Data name

value - the Data String value

Returns:

true if the Data value could be set

setDataXMLValue

public short setDataXMLValue(java.lang.String name,
                             org.mdiutil.xml.tree.XMLNode value)

Set the XML value of a Data as an XMLNode.

Parameters:

name - the Data name

value - the Data XMLNode value

Returns:

true if the Data value could be set

setDataJSONValue

public short setDataJSONValue(java.lang.String name,
                              org.json.JSONElement value)

Set the JSON value of a Data as a JSONElement.

Parameters:

name - the Data name

value - the Data XMLNode value

Returns:

true if the Data value could be set

setDataFileValue

public short setDataFileValue(java.lang.String name,
                              java.io.File value)

Set a File Data value.

Parameters:

name - the data name

value - the data File value, as a String

Returns:

the state of the data set (see DataState)

setDataURLValue

public short setDataURLValue(java.lang.String name,
                             java.net.URL value)

Set the value of a Data as an URL.

Parameters:

name - the Data name

value - the Data URL value

Returns:

true if the Data value could be set

getData

public Data<?> getData(java.lang.String name)

Return the Service Datas.

Parameters:

name - the data name

Returns:

the data value

getDataAsStructure

public Data.Structure getDataAsStructure(java.lang.String name)

Return the Data of a specified name, as a structure. it will return null if the Data is not a structure.

Parameters:

name - the name

Returns:

the Data

getDataAsArray

public Data.Array getDataAsArray(java.lang.String name)

Return the Data of a specified name, as an array. it will return null if the Data is not an array.

Parameters:

name - the name

Returns:

the Data

getDataAsMap

public Data.MapData getDataAsMap(java.lang.String name)

Return the Data of a specified name, as a Map. it will return null if the Data is not a Map.

Parameters:

name - the name

Returns:

the Data

getDataAsUnion

public Data.Union getDataAsUnion(java.lang.String name)

Return the Data of a specified name, as an Union. it will return null if the Data is not an Union.

Parameters:

name - the name

Returns:

the Data

getDataAsSwitch

public Data.Switch getDataAsSwitch(java.lang.String name)

Return the Data of a specified name, as a Switch. it will return null if the Data is not a switch.

Parameters:

name - the name

Returns:

the Data

hasData

public boolean hasData(java.lang.String name)

Return true if the Service has a Data of a specified name.

Parameters:

name - the data name

Returns:

true if the Service has a Data of the specified name

hasChanged

public boolean hasChanged(java.lang.String name)

Return true if the Data with a specified name has changed since the last reception.

Parameters:

name - the data name

Returns:

true if the Data with the specified name has changed since the last reception