org.da.protoframework.model.core

Class Data<T extends Type>

java.lang.Object

org.da.protoframework.model.core.Data<T>

Type Parameters:

T - the Data Type

All Implemented Interfaces:

java.lang.Cloneable, DataState

Direct Known Subclasses:

Data.Any, Data.Array, Data.Bool, Data.Byte, Data.Char, Data.Double, Data.Enum, Data.Float, Data.Int, Data.JSON, Data.Long, Data.MapData, Data.Nil, Data.Obj, Data.Short, Data.Str, Data.Structure, Data.Switch, Data.Union, Data.Url, Data.Void, Data.Xml

public abstract class Data<T extends Type>
extends java.lang.Object
implements DataState, java.lang.Cloneable

Represent a Data value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Data.Any The Any Data value.
static class	Data.Array The array Data value.
static class	Data.Bool The boolean Data value.
static class	Data.Byte The byte Data value.
static class	Data.Char The char Data value.
static class	Data.Double The double Data value.
static class	Data.Enum The enumeration Data value.
static class	Data.Float The float Data value.
static class	Data.Int The int Data value.
static class	Data.JSON The JSON Data value.
static class	Data.Long The long Data value.
static class	Data.MapData The array Data value.
static class	Data.Nil The boolean Data value.
static class	Data.Obj The Object Data value.
static class	Data.Short The short Data value.
static class	Data.Str The String Data value.
static class	Data.Structure The Structure Data value.
static class	Data.Switch The switch Data value.
static class	Data.Union The Union Data value.
static class	Data.Url The URL Data value.
static class	Data.Void An empty void Data value.
static class	Data.Xml The XML Data value.

Field Summary

Fields

Modifier and Type	Field and Description
static Data.Void	NULL_DATA The null Data.

Fields inherited from interface org.da.protoframework.model.core.DataState

STATE_INVALID, STATE_MODIFIED, STATE_UNCHANGED

Constructor Summary

Constructors

Constructor and Description
Data(ServiceDefinition.Data def) Constructor.

Method Summary

Modifier and Type	Method and Description
Data<?>	clone()
short	copy(Data<?> data) Copy the value of another Data.
short	copy(Data<?> data, boolean strict) Copy the value of another Data.
short	copy(Data<?> data, boolean clone, boolean strict) Copy the value of another Data.
java.lang.Object	copyValue() Copy the current value and return it.
short	getDataChangeBehavior() Return the change behavior for the data.
ServiceDefinition.Data	getDefinition() Return the Data definition.
java.lang.String	getDescription() Return the data description.
java.lang.String	getName() Return the data name.
java.lang.String	getTopic() Return the Data topic if the Data is associated with a Topic.
T	getType() Return the Data type.
abstract java.lang.Object	getValue() Return the data value.
java.lang.Object	getValue(java.lang.Class<?> clazz) Return the data value cast to a tagged instance.
java.util.List<java.lang.Object>	getValueAsArray() Return the data value as an array.
boolean	getValueAsBoolean() Return the data value as a boolean.
byte	getValueAsByte() Return the data value as a byte.
char	getValueAsChar() Return the data value as a char.
boolean	getValueAsData(Data<?> data) Return the value of a Data as another data.
double	getValueAsDouble() Return the data value as a double.
double	getValueAsDouble(short unit) Return the data value as a double, in a specified unit.
float	getValueAsFloat() Return the data value as a float.
float	getValueAsFloat(short unit) Return the data value as a float, in a specified unit.
int	getValueAsInt() Return the data value as an int.
org.json.JSONElement	getValueAsJSON() Return the data value as a JSONElement.
long	getValueAsLong() Return the data value as a long.
java.util.Map<java.lang.Object,java.lang.Object>	getValueAsMap() Return the data value as a Map.
short	getValueAsShort() Return the data value as a short.
java.lang.String	getValueAsString() Return the data value as a String.
java.util.List<java.lang.Object>	getValueAsStructure() Return the data value as a Structure.
java.util.List<java.lang.Object>	getValueAsUnion() Return the data value as an union.
java.net.URL	getValueAsURL() Return the data value as an URL.
org.mdiutil.xml.tree.XMLNode	getValueAsXML() Return the data value as an XML structure.
boolean	hasChanged() Return true if the data has been changed.
boolean	isContinuous() Return true if the data represents a continuous quantity.
boolean	isEqualsTo(java.lang.Object o) Return true if the current value of the data is equal to a current object value.
boolean	isNumeric() Return true if the data type is numeric.
short	setBooleanValue(boolean value) Set the data boolean value.
short	setByteValue(byte value) Set the data byte value.
short	setChanged(boolean hasChanged) Set if the data has been changed.
short	setCharValue(char value) Set the data char value.
short	setDoubleValue(double value) Set the data double value.
short	setDoubleValue(double value, short unit) Set the data double value, in a specified unit.
short	setFloatValue(double value, short unit) Set the data float value, in a specified unit.
short	setFloatValue(float value) Set the data float value.
short	setIntValue(int value) Set the data int value.
short	setLongValue(long value) Set the data long value.
short	setShortValue(int value) Set the data short value.
short	setStringValue(java.lang.String value) Set the data String value.
abstract short	setValue(java.lang.Object value) Set the data value.
short	setValueFromInstance(java.lang.Object instance) Return the data value as a tagged instance.
void	touch() Declare that the data has changed.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_DATA

public static final Data.Void NULL_DATA

The null Data. This is a Data which has an undefined value and type, and is never modified.

Constructor Detail

Data

public Data(ServiceDefinition.Data def)

Constructor.

Parameters:

def - the Data definition

Method Detail

getType

public T getType()

Return the Data type.

Returns:

the Data type

isNumeric

public boolean isNumeric()

Return true if the data type is numeric.

Returns:

true if the data type is numeric

isContinuous

public boolean isContinuous()

Return true if the data represents a continuous quantity. Note that this property has only a meaning for numeric values.

Returns:

true true if the data represents a continuous quantity

getTopic

public java.lang.String getTopic()

Return the Data topic if the Data is associated with a Topic.

Returns:

the data topic

getDataChangeBehavior

public short getDataChangeBehavior()

Return the change behavior for the data.

Returns:

the change behavior for the data

getName

public java.lang.String getName()

Return the data name.

Returns:

the data name

getDescription

public java.lang.String getDescription()

Return the data description.

Returns:

the data description

getDefinition

public ServiceDefinition.Data getDefinition()

Return the Data definition.

Returns:

the Data definition

copy

public short copy(Data<?> data,
                  boolean strict)

Copy the value of another Data.

Parameters:

data - the data

strict - true if the framework should check if the types of the datas are compatible

Returns:

the result of the modification

See Also:

DataState

copy

public short copy(Data<?> data,
                  boolean clone,
                  boolean strict)

Copy the value of another Data.

Parameters:

data - the data

clone - true if the content of the data must be cloned

strict - true if the framework should check if the types of the datas are compatible

Returns:

the result of the modification

See Also:

DataState

copy

public short copy(Data<?> data)

Copy the value of another Data. By default it is a strict copy.

Parameters:

data - the data

Returns:

the result of the modification

See Also:

DataState

clone

public Data<?> clone()
              throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

touch

public void touch()

Declare that the data has changed. Refer to setChanged(boolean) with true as argument.

setChanged

public short setChanged(boolean hasChanged)

Set if the data has been changed.

Parameters:

hasChanged - true if the data has been changed

Returns:

the change state

hasChanged

public boolean hasChanged()

Return true if the data has been changed.

Returns:

true if the data has been changed

setIntValue

public short setIntValue(int value)

Set the data int value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setShortValue

public short setShortValue(int value)

Set the data short value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setByteValue

public short setByteValue(byte value)

Set the data byte value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setCharValue

public short setCharValue(char value)

Set the data char value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setLongValue

public short setLongValue(long value)

Set the data long value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setFloatValue

public short setFloatValue(float value)

Set the data float value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setFloatValue

public short setFloatValue(double value,
                           short unit)

Set the data float value, in a specified unit.

Parameters:

value - the value

unit - the unit

Returns:

the result of the modification, see DataState

setDoubleValue

public short setDoubleValue(double value)

Set the data double value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setDoubleValue

public short setDoubleValue(double value,
                            short unit)

Set the data double value, in a specified unit.

Parameters:

value - the value

unit - the unit

Returns:

the result of the modification, see DataState

setBooleanValue

public short setBooleanValue(boolean value)

Set the data boolean value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setStringValue

public short setStringValue(java.lang.String value)

Set the data String value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

setValue

public abstract short setValue(java.lang.Object value)

Set the data value.

Parameters:

value - the value

Returns:

the result of the modification, see DataState

getValue

public abstract java.lang.Object getValue()

Return the data value.

Returns:

the value

copyValue

public java.lang.Object copyValue()

Copy the current value and return it.

Returns:

the copied value

getValue

public java.lang.Object getValue(java.lang.Class<?> clazz)

Return the data value cast to a tagged instance.

Parameters:

clazz - the instance class

Returns:

the value as an instance of the specified class

setValueFromInstance

public short setValueFromInstance(java.lang.Object instance)

Return the data value as a tagged instance.

Parameters:

instance - the instance

Returns:

the result of the modification, see DataState

isEqualsTo

public boolean isEqualsTo(java.lang.Object o)

Return true if the current value of the data is equal to a current object value.

Parameters:

o - the specified object value

Returns:

true if the current value of the data is equal to a current object value

getValueAsUnion

public java.util.List<java.lang.Object> getValueAsUnion()

Return the data value as an union.

Returns:

the value

getValueAsArray

public java.util.List<java.lang.Object> getValueAsArray()

Return the data value as an array.

Returns:

the value

getValueAsData

public boolean getValueAsData(Data<?> data)

Return the value of a Data as another data.

Parameters:

data - the other data. The content of this data will be filled with the value of this data

Returns:

the other data

getValueAsMap

public java.util.Map<java.lang.Object,java.lang.Object> getValueAsMap()

Return the data value as a Map.

Returns:

the value

getValueAsStructure

public java.util.List<java.lang.Object> getValueAsStructure()

Return the data value as a Structure.

Returns:

the value

getValueAsInt

public int getValueAsInt()

Return the data value as an int.

Returns:

the value

getValueAsLong

public long getValueAsLong()

Return the data value as a long.

Returns:

the value

getValueAsDouble

public double getValueAsDouble(short unit)

Return the data value as a double, in a specified unit.

Parameters:

unit - the unit

Returns:

the value

getValueAsDouble

public double getValueAsDouble()

Return the data value as a double.

Returns:

the value

getValueAsFloat

public float getValueAsFloat(short unit)

Return the data value as a float, in a specified unit.

Parameters:

unit - the unit

Returns:

the value

getValueAsFloat

public float getValueAsFloat()

Return the data value as a float.

Returns:

the value

getValueAsShort

public short getValueAsShort()

Return the data value as a short.

Returns:

the value

getValueAsByte

public byte getValueAsByte()

Return the data value as a byte.

Returns:

the value

getValueAsChar

public char getValueAsChar()

Return the data value as a char.

Returns:

the value

getValueAsBoolean

public boolean getValueAsBoolean()

Return the data value as a boolean.

Returns:

the value

getValueAsString

public java.lang.String getValueAsString()

Return the data value as a String.

Returns:

the value

getValueAsXML

public org.mdiutil.xml.tree.XMLNode getValueAsXML()

Return the data value as an XML structure.

Returns:

the value

getValueAsJSON

public org.json.JSONElement getValueAsJSON()

Return the data value as a JSONElement.

Returns:

the value

getValueAsURL

public java.net.URL getValueAsURL()

Return the data value as an URL.

Returns:

the value