org.da.protoframework.util

Class DataUtilities

java.lang.Object

org.da.protoframework.util.DataUtilities

public class DataUtilities
extends java.lang.Object

Various utilities for managing the Data values.

Method Summary

Modifier and Type	Method and Description
static boolean	checkDataType(java.lang.Object v, Type type) Return true if a value is compatible with a type.
static java.lang.Object	copyValue(Type fromType, java.lang.Object fromValue, Type toType) Copy a value from one type to another.
static Data<?>	createData(ServiceDefinition.Data dataDef) Create a Data for a Service.
static Data<?>	createData(Type type) Create a Data for a type.
static java.lang.String	formatTimeStamp(java.time.Duration duration) Format a time stamp value.
static java.lang.Object	getFieldValue(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure.
static java.util.List<java.lang.Object>	getFieldValueAsArray(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a short.
static boolean	getFieldValueAsBoolean(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a boolean.
static char	getFieldValueAsChar(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a char.
static double	getFieldValueAsDouble(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a double.
static float	getFieldValueAsFloat(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a float.
static int	getFieldValueAsInt(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as an int.
static long	getFieldValueAsLong(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a long.
static short	getFieldValueAsShort(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName) Return the value of a field for a Structure as a short.
static EnumType.State	getState(EnumType enumType, java.lang.String stateName) Return the state for a state name.
static int	getStateValue(EnumType enumType, java.lang.String stateName) Return the state value for a state name.
static Type	getTerminalType(Type type) Return the terminal type corresponding to a type.
static java.util.List<java.lang.Object>	getValue(Type type, org.json.JSONArray jsonArray) Return a value from a JSONArray
static java.lang.Object	getValue(Type type, org.json.JSONObject json) Return a value from a JSONObject
static java.lang.Object	getValueFromString(Type type, java.lang.String value) Return the value corresponding with a String.
static boolean	setFieldValue(StructType struct, java.util.List<java.lang.Object> value, java.lang.String fieldName, java.lang.Object fieldValue) Set the value of a field for a Structure.
static org.json.JSONElement	toJSON(Data<?> data, boolean enumStateAsString) Convert the content of a data as a JSON element.
static org.json.JSONObject	toJSON(ServiceInstance<?,?> service, boolean enumStateAsString) Convert the content of a service as a JSON object.

Methods inherited from class java.lang.Object

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

Method Detail

formatTimeStamp

public static final java.lang.String formatTimeStamp(java.time.Duration duration)

Format a time stamp value.

Parameters:

duration - the time stamp as a duration

Returns:

the formatted time stamp value

getTerminalType

public static Type getTerminalType(Type type)

Return the terminal type corresponding to a type.

Parameters:

type - the type

Returns:

the terminal type

checkDataType

public static boolean checkDataType(java.lang.Object v,
                                    Type type)

Return true if a value is compatible with a type.

Parameters:

v - the value

type - the type

Returns:

true if the value is compatible with the type

getFieldValue

public static java.lang.Object getFieldValue(StructType struct,
                                             java.util.List<java.lang.Object> value,
                                             java.lang.String fieldName)

Return the value of a field for a Structure.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or null if the field value does not exist

getFieldValueAsFloat

public static float getFieldValueAsFloat(StructType struct,
                                         java.util.List<java.lang.Object> value,
                                         java.lang.String fieldName)

Return the value of a field for a Structure as a float.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or 0 if the field value does not exist or is not a numeric value

getFieldValueAsDouble

public static double getFieldValueAsDouble(StructType struct,
                                           java.util.List<java.lang.Object> value,
                                           java.lang.String fieldName)

Return the value of a field for a Structure as a double.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or 0 if the field value does not exist or is not a numeric value

getFieldValueAsInt

public static int getFieldValueAsInt(StructType struct,
                                     java.util.List<java.lang.Object> value,
                                     java.lang.String fieldName)

Return the value of a field for a Structure as an int.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or 0 if the field value does not exist or is not a numeric value

getFieldValueAsShort

public static short getFieldValueAsShort(StructType struct,
                                         java.util.List<java.lang.Object> value,
                                         java.lang.String fieldName)

Return the value of a field for a Structure as a short.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or 0 if the field value does not exist or is not a numeric value

getFieldValueAsLong

public static long getFieldValueAsLong(StructType struct,
                                       java.util.List<java.lang.Object> value,
                                       java.lang.String fieldName)

Return the value of a field for a Structure as a long.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or 0 if the field value does not exist or is not a numeric value

getFieldValueAsBoolean

public static boolean getFieldValueAsBoolean(StructType struct,
                                             java.util.List<java.lang.Object> value,
                                             java.lang.String fieldName)

Return the value of a field for a Structure as a boolean.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or false if the field value does not exist or is not a boolean

getFieldValueAsChar

public static char getFieldValueAsChar(StructType struct,
                                       java.util.List<java.lang.Object> value,
                                       java.lang.String fieldName)

Return the value of a field for a Structure as a char.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or false if the field value does not exist or is not a char or a numeric value

getFieldValueAsArray

public static java.util.List<java.lang.Object> getFieldValueAsArray(StructType struct,
                                                                    java.util.List<java.lang.Object> value,
                                                                    java.lang.String fieldName)

Return the value of a field for a Structure as a short.

Parameters:

struct - the structure

value - the value for the structure

fieldName - the field name

Returns:

the value, or an empty array if the field does not correspond to an array

setFieldValue

public static boolean setFieldValue(StructType struct,
                                    java.util.List<java.lang.Object> value,
                                    java.lang.String fieldName,
                                    java.lang.Object fieldValue)

Set the value of a field for a Structure.

Parameters:

struct - the structure

fieldName - the field name

value - the value for the structure

fieldValue - the value for the field

Returns:

true if the value could be set

getValueFromString

public static java.lang.Object getValueFromString(Type type,
                                                  java.lang.String value)

Return the value corresponding with a String. Note that it will return null for types which are not SimpleType.

Parameters:

type - the type

value - the value as a String

Returns:

the value

getState

public static EnumType.State getState(EnumType enumType,
                                      java.lang.String stateName)

Return the state for a state name.

Parameters:

enumType - the Enumeration type

stateName - the state name

Returns:

the state

getStateValue

public static int getStateValue(EnumType enumType,
                                java.lang.String stateName)

Return the state value for a state name.

Parameters:

enumType - the Enumeration type

stateName - the state name

Returns:

the state value (or -1 if the state is not found)

createData

public static Data<?> createData(ServiceDefinition.Data dataDef)

Create a Data for a Service.

Parameters:

dataDef - the Data definition

Returns:

the Data

createData

public static Data<?> createData(Type type)

Create a Data for a type.

Parameters:

type - the type

Returns:

the Data

getValue

public static java.util.List<java.lang.Object> getValue(Type type,
                                                        org.json.JSONArray jsonArray)

Return a value from a JSONArray

Parameters:

type - the data type

jsonArray - the JSONArray

Returns:

the value

getValue

public static java.lang.Object getValue(Type type,
                                        org.json.JSONObject json)

Return a value from a JSONObject

Parameters:

type - the data type

json - the JSONObject

Returns:

the value

toJSON

public static org.json.JSONElement toJSON(Data<?> data,
                                          boolean enumStateAsString)
                                   throws org.json.JSONException

Convert the content of a data as a JSON element. Note that if the data has a SimpleType, the method will return null.

Parameters:

data - the data

enumStateAsString - true if the enumeration states should be converted as Strings

Returns:

the JSON object

Throws:

org.json.JSONException

toJSON

public static org.json.JSONObject toJSON(ServiceInstance<?,?> service,
                                         boolean enumStateAsString)
                                  throws org.json.JSONException

Convert the content of a service as a JSON object.

Parameters:

service - the service

enumStateAsString - true if the enumeration states should be converted as Strings

Returns:

the JSON object

Throws:

org.json.JSONException

copyValue

public static java.lang.Object copyValue(Type fromType,
                                         java.lang.Object fromValue,
                                         Type toType)

Copy a value from one type to another. It will return null if the value could not be copied

Parameters:

fromType - the type from which to copy the value

fromValue - to value to copy

toType - the type to which to copy the value

Returns:

thr copied value