org.eclipse.milo.opcua.stack.core.types

Class OpcUaXmlDataTypeDictionary

java.lang.Object

org.eclipse.milo.opcua.stack.core.types.OpcUaXmlDataTypeDictionary

All Implemented Interfaces:

DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

public class OpcUaXmlDataTypeDictionary
extends Object
implements DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Constructor Summary

Constructors

Constructor and Description
OpcUaXmlDataTypeDictionary(String namespaceUri)
OpcUaXmlDataTypeDictionary(String namespaceUri, Map<String,OpcUaXmlDataTypeCodec<?>> byDescription, Map<NodeId,OpcUaXmlDataTypeCodec<?>> byEncodingId, Map<NodeId,OpcUaXmlDataTypeCodec<?>> byDataTypeId)

Method Summary

Modifier and Type	Method and Description
OpcUaXmlDataTypeCodec<?>	getCodec(NodeId dataTypeId) Get a DataTypeCodec registered with this dictionary.
OpcUaXmlDataTypeCodec<?>	getCodec(String description) Get a DataTypeCodec registered with this dictionary.
Map<NodeId,OpcUaXmlDataTypeCodec<?>>	getCodecsByDataTypeId()
Map<String,OpcUaXmlDataTypeCodec<?>>	getCodecsByDescription()
Map<NodeId,OpcUaXmlDataTypeCodec<?>>	getCodecsByEncodingId()
QualifiedName	getEncodingName()
String	getNamespaceUri()
void	registerEnumCodec(OpcUaXmlDataTypeCodec<?> codec, String description) Register a DataTypeCodec that serializes an enumeration with this dictionary.
void	registerEnumCodec(OpcUaXmlDataTypeCodec<?> codec, String description, NodeId dataTypeId) Register a DataTypeCodec that serializes an enumeration with this dictionary.
void	registerStructCodec(OpcUaXmlDataTypeCodec<?> codec, String description, NodeId dataTypeId, NodeId encodingId) Register a DataTypeCodec that serializes a structure with this dictionary.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.stack.core.types.DataTypeDictionary

getCodecByDataTypeId, getCodecByDescription, getCodecByEncodingId

Constructor Detail

OpcUaXmlDataTypeDictionary

public OpcUaXmlDataTypeDictionary(String namespaceUri)

OpcUaXmlDataTypeDictionary

public OpcUaXmlDataTypeDictionary(String namespaceUri,
                                  Map<String,OpcUaXmlDataTypeCodec<?>> byDescription,
                                  Map<NodeId,OpcUaXmlDataTypeCodec<?>> byEncodingId,
                                  Map<NodeId,OpcUaXmlDataTypeCodec<?>> byDataTypeId)

Method Detail

getNamespaceUri

public String getNamespaceUri()

Specified by:

getNamespaceUri in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Returns:

the namespace URI this DataTypeDictionary belongs to.

getEncodingName

public QualifiedName getEncodingName()

Specified by:

getEncodingName in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Returns:

the name of the datatype encoding for codecs in this dictionary.

getCodec

public OpcUaXmlDataTypeCodec<?> getCodec(String description)

Description copied from interface: DataTypeDictionary

Get a DataTypeCodec registered with this dictionary.

Specified by:

getCodec in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Parameters:

description - the value of the DataTypeDescription that identifies the codec in the dictionary.

Returns:

a DataTypeCodec for description, or null if none is found.

getCodec

public OpcUaXmlDataTypeCodec<?> getCodec(NodeId dataTypeId)

Description copied from interface: DataTypeDictionary

Get a DataTypeCodec registered with this dictionary.

Specified by:

getCodec in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Parameters:

dataTypeId - the NodeId of the DataType Node for the DataType serialized by the codec.

Returns:

a DataTypeCodec for dataTypeId, or null if none is found.

registerEnumCodec

public void registerEnumCodec(OpcUaXmlDataTypeCodec<?> codec,
                              String description)

Description copied from interface: DataTypeDictionary

Register a DataTypeCodec that serializes an enumeration with this dictionary.

Specified by:

registerEnumCodec in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

registerEnumCodec

public void registerEnumCodec(OpcUaXmlDataTypeCodec<?> codec,
                              String description,
                              NodeId dataTypeId)

Description copied from interface: DataTypeDictionary

Register a DataTypeCodec that serializes an enumeration with this dictionary.

Specified by:

registerEnumCodec in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

dataTypeId - the NodeId of the DataType Node for the DataType serialized by codec.

registerStructCodec

public void registerStructCodec(OpcUaXmlDataTypeCodec<?> codec,
                                String description,
                                NodeId dataTypeId,
                                NodeId encodingId)

Description copied from interface: DataTypeDictionary

Register a DataTypeCodec that serializes a structure with this dictionary.

Specified by:

registerStructCodec in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

dataTypeId - the NodeId of the DataType Node for the DataType serialized by codec.

encodingId - the NodeId of the appropriate DataTypeEncoding Node for the DataType serialized by codec.

getCodecsByDescription

public Map<String,OpcUaXmlDataTypeCodec<?>> getCodecsByDescription()

Specified by:

getCodecsByDescription in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Returns:

a Map of all codecs registered with this dictionary, keyed by description.

getCodecsByEncodingId

public Map<NodeId,OpcUaXmlDataTypeCodec<?>> getCodecsByEncodingId()

Specified by:

getCodecsByEncodingId in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Returns:

a Map of all codecs registered with this dictionary, keyed by encoding id.

getCodecsByDataTypeId

public Map<NodeId,OpcUaXmlDataTypeCodec<?>> getCodecsByDataTypeId()

Specified by:

getCodecsByDataTypeId in interface DataTypeDictionary<OpcUaXmlDataTypeCodec<?>>

Returns:

a Map of all codecs registered with this dictionary, keyed by datatype id.