com.prosysopc.ua

Class DataTypeConverter

java.lang.Object

com.prosysopc.ua.DataTypeConverter

public class DataTypeConverter
extends Object

A converter class, used to convert UA Values between different DataTypes.

Note that this class is not meant to be instantiated directly. On the Client side, UaClient.getAddressSpace().getDataTypeConverter() will return the relevant converter.

On the Server side, the converter is available from UaServer.getNodeManagerRoot().getDataTypeConverter().

Constructor Summary

Constructors

Constructor and Description
DataTypeConverter(UaAddressSpace addressSpace) Creates a new DataTypeConverter, using a given AddressSpace that is used to look up the UaDataType Nodes that are used.

Method Summary

Modifier and Type	Method and Description
protected Boolean	booleanValue(Object value) Returns the value of the specified Variant as a boolean.
Variant	convert(Variant value, Class<?> toClass) Convert the given Variant value to a new Variant of the DataType specified with the given Java class.
Variant	convert(Variant value, NodeId dataTypeId) Convert the given Variant value to a new Variant of the DataType specified with the given NodeId.
Variant	convert(Variant value, UaDataType dataType) Convert the given Variant value to a new Variant of the specified DataType.
protected Object	convertValue(Object value, Class<?> fromClass, Class<?> toClass) Tries to convert the given value from the given class to another given class.
protected Object	convertVariant(Variant value, Class<?> fromClass, Class<?> toClass) Tries to convert the value of the given Variant from the given class to another given class.
UaDataType	getDataTypeForJavaClass(Class<?> clazz) Deprecated. Use getDataTypesForJavaClass(Class) instead as it returns all possible types. This method just returns the first entry.
UaDataType[]	getDataTypesForJavaClass(Class<?> clazz) Returns the UA DataTypes that correspond to the given Java class.
boolean	isNullable(NodeId dataType) Deprecated. returns true for all data types
protected Object	numberToInteger(Number number, NodeId dataTypeId) Converts a Number to a UA Integer value.
protected Object	numberToInteger(Number number, UaDataType dataType) Converts a Number to a UA Integer value.
Variant	parseVariant(String string, Class<?> javaClass) Parse a string to a Variant of the DataType specified with the given Java class.
Variant	parseVariant(String string, NodeId dataTypeId) Parse a string to a Variant of the DataType specified with the given NodeId.
Variant	parseVariant(String string, UaDataType dataType) Parse a string to a Variant of the specified DataType.
protected Number	toNumber(Object value, Class<?> toClass) Convert the given value to the given class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeConverter

public DataTypeConverter(UaAddressSpace addressSpace)

Creates a new DataTypeConverter, using a given AddressSpace that is used to look up the UaDataType Nodes that are used.

Method Detail

convert

public Variant convert(Variant value,
                       Class<?> toClass)
                throws DataTypeConversionException

Convert the given Variant value to a new Variant of the DataType specified with the given Java class.

The type conversions work in principle, according to the Conversion Rules specified in [OPC UA Part4. Table 113].

Parameters:

value - the Variant value to convert.

toClass - Java class type, which defines the desired DataType

Returns:

a new Variant of the specified DataType. If the value of the given Variant is null, the the value of the returned Variant is null.

Throws:

DataTypeConversionException - if the conversion fails

convert

public Variant convert(Variant value,
                       NodeId dataTypeId)
                throws DataTypeConversionException

Convert the given Variant value to a new Variant of the DataType specified with the given NodeId.

The type conversions work in principle, according to the Conversion Rules specified in [OPC UA Part4. Table 113].

The conversions rely on UaDataType Nodes that define the proper JavaClass. This is true for the types in the default AddressSpace, both in the Server and Client Nodes of the SDK.

If you define your own DataTypes, make sure that they inherit from the correct base DataTypes or define the JavaClass for each node yourself.

Parameters:

value - the Variant value to convert.

dataTypeId - the NodeId of the UA Data Type to convert to.

Returns:

a new Variant of the specified DataType. If the value of the given Variant is null, the the value of the returned Variant is null.

Throws:

DataTypeConversionException - if the conversion fails

convert

public Variant convert(Variant value,
                       UaDataType dataType)
                throws DataTypeConversionException

Convert the given Variant value to a new Variant of the specified DataType.

The type conversions work in principle, according to the Conversion Rules specified in [OPC UA Part4. Table 113].

The conversions rely on UaDataType Nodes that define the proper JavaClass. This is true for the types in the default AddressSpace, both in the Server and Client Nodes of the SDK.

If you define your own DataTypes, make sure that they inherit from the correct base DataTypes or define the JavaClass for each node yourself.

Parameters:

value - the Variant value to convert.

dataType - the UA DataType to convert to.

Returns:

a new Variant of the specified DataType. If the value of the given Variant is null, the the value of the returned Variant is null.

Throws:

DataTypeConversionException - if the conversion fails

IllegalArgumentException - if the given dataType is null

getDataTypeForJavaClass

@Deprecated
public UaDataType getDataTypeForJavaClass(Class<?> clazz)

Deprecated. Use getDataTypesForJavaClass(Class) instead as it returns all possible types. This method just returns the first entry.

Returns a UA data type that corresponds to a Java class. Note! this returns one of possible data types, there may be multiple data types for a Java class, use DataTypeConverter.getDataTypesForJavaClass to get them all

Parameters:

clazz - the Java class

Returns:

the UaDataType node

Throws:

IllegalArgumentException - if a suitable data type is not found

getDataTypesForJavaClass

public UaDataType[] getDataTypesForJavaClass(Class<?> clazz)

Returns the UA DataTypes that correspond to the given Java class.

Note, that there could be multiple DataTypes that correspond to a Java class.

Parameters:

clazz - the Java class

Returns:

the matching UaDataType Nodes

Throws:

IllegalArgumentException - if a suitable DataType is not found

RuntimeException - if DataTypeConverter cannot be initialized (e.g. on Client side if the Client is not connected to the Server).

isNullable

@Deprecated
public boolean isNullable(NodeId dataType)

Deprecated. returns true for all data types

Returns true for all data types, i.e. they are all accepting null values.

parseVariant

public Variant parseVariant(String string,
                            Class<?> javaClass)

Parse a string to a Variant of the DataType specified with the given Java class.

The method will try to find the UaDataType that corresponds to the given Java class. If no UaDataType Node is found, the value is treated as a string value.

Parameters:

string - string to parse

javaClass - Java class type, which defines the desired DataType.

Returns:

a new Variant with value initialized to the specified DataType.

Throws:

IllegalArgumentException - if the parsing fails

NullPointerException - if string is null

parseVariant

public Variant parseVariant(String string,
                            NodeId dataTypeId)

Parse a string to a Variant of the DataType specified with the given NodeId.

If no UaDataType Node is found for dataTypeId, the value is treated as a string value.

Parameters:

string - string to parse

dataTypeId - NodeId of the DataType to create: This must correspond to a UaDataType Node in the NodeMap used by the converter.

Returns:

a new Variant with value initialized to the specified DataType.

Throws:

IllegalArgumentException - if the parsing fails

NullPointerException - if string is null

parseVariant

public Variant parseVariant(String string,
                            UaDataType dataType)

Parse a string to a Variant of the specified DataType.

Uses the JavaClass property of UaDataType to determine the target Java class. The conversion is done using that type's parse-method, for example, Integer.parseInt(). The JavaClasses of the default types are predefined.

Parameters:

string - string to parse. Must not be null

dataType - DataType to create. The JavaClass of the DataType must be defined: the conversion will be done using this class.

Returns:

a new Variant with value initialized to the specified DataType.

Throws:

IllegalArgumentException - if the parsing fails

NullPointerException - if string is null

booleanValue

protected Boolean booleanValue(Object value)
                        throws DataTypeConversionException

Returns the value of the specified Variant as a boolean.

Parameters:

value - the value to convert to Boolean.

Returns:

the Variant value as boolean, if it can be cast to such, or null if the Variant value is null.

Throws:

DataTypeConversionException - if the Variant value is not null, but cannot be cast to boolean

convertValue

protected Object convertValue(Object value,
                              Class<?> fromClass,
                              Class<?> toClass)
                       throws DataTypeConversionException

Tries to convert the given value from the given class to another given class.

Parameters:

value - the value to convert.

fromClass - the source class.

toClass - the target class.

Returns:

the converted value.

Throws:

DataTypeConversionException - if the conversion fails

convertVariant

protected Object convertVariant(Variant value,
                                Class<?> fromClass,
                                Class<?> toClass)
                         throws DataTypeConversionException

Tries to convert the value of the given Variant from the given class to another given class.

Parameters:

value - the Variant to convert.

fromClass - the source class.

toClass - the target class.

Returns:

the converted value.

Throws:

DataTypeConversionException - if the conversion fails

numberToInteger

protected Object numberToInteger(Number number,
                                 NodeId dataTypeId)

Converts a Number to a UA Integer value.

Parameters:

number - the Number to convert.

dataTypeId - the NodeId of the Integer DataType.

Returns:

the converted value, or null if the matching DataType is not subtype of Integer or representable by integer.

numberToInteger

protected Object numberToInteger(Number number,
                                 UaDataType dataType)

Converts a Number to a UA Integer value.

Parameters:

number - the Number to convert.

dataType - the Integer DataType.

Returns:

the converted value, or null if the given DataType is not subtype of Integer or representable by integer.

toNumber

protected Number toNumber(Object value,
                          Class<?> toClass)
                   throws ClassCastException

Convert the given value to the given class.

Parameters:

value - the value to convert.

toClass - the Number class.

Returns:

the converted Number.

Throws:

ClassCastException - if the conversion fails