org.eclipse.milo.opcua.sdk.core

Class DataTypeTree

java.lang.Object

org.eclipse.milo.opcua.sdk.core.DataTypeTree

public class DataTypeTree
extends Object

A tree-based representation of a DataType hierarchy.

Allows for convenient operations such as:

• resolving the backing Class for a value of a given DataType
• reducing a DataType to its inherited builtin type
• checking if a Class would be assignable to a value of some DataType
• retrieving the encoding ids for structured DataTypes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataTypeTree.DataType Data object that holds details of a DataType: Browse Name of the DataType Node NodeId of the DataType Node NodeId of the Binary Encoding Node NodeId of the XML Encoding Node

Constructor Summary

Constructors

Constructor and Description
DataTypeTree(Tree<DataTypeTree.DataType> tree)

Method Summary

Modifier and Type	Method and Description
Class<?>	getBackingClass(NodeId dataTypeId) Get the backing Class a value of DataType dataTypeId would have.
@Nullable NodeId	getBinaryEncodingId(NodeId dataTypeId) Get the NodeId of the Binary Encoding Node for the DataType identified by dataTypeId.
BuiltinDataType	getBuiltinType(NodeId dataTypeId) Get the BuiltinDataType dataTypeId inherits from, following references to the parent as necessary until a BuiltinDataType is found.
@Nullable DataTypeTree.DataType	getDataType(NodeId dataTypeId) Get the DataTypeTree.DataType info for the DataType identified by dataTypeId, if it exists.
Tree<DataTypeTree.DataType>	getTree() Get the underlying Tree structure.
@Nullable Tree<DataTypeTree.DataType>	getTreeNode(NodeId dataTypeId) Get the underlying Tree node for the DataType identified by dataTypeId.
@Nullable NodeId	getXmlEncodingId(NodeId dataTypeId) Get the NodeId of the XML Encoding Node for the DataType identified by dataTypeId.
boolean	isAssignable(NodeId dataTypeId, Class<?> clazz) Check if a value of type clazz is assignable to a value of DataType dataTypeId, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeTree

public DataTypeTree(Tree<DataTypeTree.DataType> tree)

Method Detail

getBackingClass

public Class<?> getBackingClass(NodeId dataTypeId)

Get the backing Class a value of DataType dataTypeId would have.

Builtin DataTypes are backed by their intrinsic backing class.

Abstract types Identifiers.Number, Identifiers.Integer, and Identifiers.UInteger are backed by Number, Integer, and UInteger respectively.

Enumerations are backed by Integer.

Structures are backed by ExtensionObject.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the backing Class a value of DataType dataTypeId would have.

See Also:

BuiltinDataType, BuiltinDataType.getBackingClass()

getBuiltinType

public BuiltinDataType getBuiltinType(NodeId dataTypeId)

Get the BuiltinDataType dataTypeId inherits from, following references to the parent as necessary until a BuiltinDataType is found.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the BuiltinDataType this DataType inherits from.

getDataType

@Nullable
public @Nullable DataTypeTree.DataType getDataType(NodeId dataTypeId)

Get the DataTypeTree.DataType info for the DataType identified by dataTypeId, if it exists.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the DataTypeTree.DataType info for the DataType identified by dataTypeId, if it exists.

getBinaryEncodingId

@Nullable
public @Nullable NodeId getBinaryEncodingId(NodeId dataTypeId)

Get the NodeId of the Binary Encoding Node for the DataType identified by dataTypeId.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the NodeId of the Binary Encoding Node, or null if none exists.

getXmlEncodingId

@Nullable
public @Nullable NodeId getXmlEncodingId(NodeId dataTypeId)

Get the NodeId of the XML Encoding Node for the DataType identified by dataTypeId.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the NodeId of the XML Encoding Node, or null if none exists.

isAssignable

public boolean isAssignable(NodeId dataTypeId,
                            Class<?> clazz)

Check if a value of type clazz is assignable to a value of DataType dataTypeId, i.e. it is equal to or a subtype of the backing class for dataTypeId.

Parameters:

dataTypeId - the NodeId of a DataType Node.

clazz - the backing Class to check.

Returns:

true if clazz is equal to or a subtype of the backing class for dataTypeId.

getTree

public Tree<DataTypeTree.DataType> getTree()

Get the underlying Tree structure.

Returns:

the underlying Tree structure.

getTreeNode

@Nullable
public @Nullable Tree<DataTypeTree.DataType> getTreeNode(NodeId dataTypeId)

Get the underlying Tree node for the DataType identified by dataTypeId.

Parameters:

dataTypeId - the NodeId of a DataType Node.

Returns:

the underlying Tree node for the DataType identified by dataTypeId.