com.prosysopc.ua.typedictionary

Class TypeDictionary

java.lang.Object

com.prosysopc.ua.typedictionary.TypeDictionary

public class TypeDictionary
extends Object

This class handles fetching metadata related to custom Structures.

Constructor Summary

Constructors

Constructor and Description
TypeDictionary(UaClient client)

Method Summary

Modifier and Type	Method and Description
ExtensionObject	binaryEncode(Structure structure) Encode a Structure that has been decoded previously with decode(ExtensionObject).
void	clearCaches() Clears all caches.
Structure	decode(ExtensionObject extensionObject) Try to decode a Structure, whose serializer is unknown.
UaDataTypeSpecification	getDataTypeSpecification(UaNodeId id) Returns an UaDataTypeSpecification that matches the given DataType node id.
EnumerationSpecification	getEnumerationSpecification(UaNodeId id) Returns an EnumerationSpecification that matches the given Enumeration DataType node id.
OptionSetSpecification	getOptionSetSpecification(UaNodeId id) Returns a OptionSetSpecification for the given id.
SimpleTypeSpecification	getSimpleTypeSpecification(UaNodeId id) Returns an SimpleTypeSpecification that matches the given DataType node id.
StructureSpecification	getStructureSpecification(UaNodeId id) Returns a StructureSpecification for the given id.
void	init() Initializes the TypeDictionary.
void	init(boolean shallow) Initialize TypeDictionary, on false works the same as init.
boolean	isUseParallelCalls() Returns true if initialization process can use parallel calls to the server.
void	refresh() Refreshes the dictionary.
void	setTreatNullDataTypeAsBaseDataType(boolean treatNullDataTypeAsBaseDataType) This setting handles a workaround for servers that incorrectly use a Null NodeId instead of having a proper DataTypeId in a StructureField definition of a StructureDefinition in the DataTypeDefinition Attribute.
void	setTreatOpcStringAsOpcCharArray(boolean treatOpcStringAsOpcCharArray) This setting handles a workaround for servers erroneously describing DataType Strings in the dictionaries as opc:String instead of opc:CharArray and still encoding the data as opc:CharArray.
void	setUseParallelCalls(boolean useParallelCalls) Set to true if initialization process is allowed to use parallel calls to the server.
void	setWarnOnlyOnErroneousDictionaries(boolean warnOnlyOnErroneousDictionaries) This setting handles a workaround for servers erroneously failing to provide proper inverse references from dictionary nodes to the datatype nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeDictionary

public TypeDictionary(UaClient client)

Method Detail

binaryEncode

public ExtensionObject binaryEncode(Structure structure)
                             throws EncodingException

Encode a Structure that has been decoded previously with decode(ExtensionObject).

Parameters:

structure - a structure

Returns:

binaryencoded version of the structure

Throws:

EncodingException - if encoding cannot be done

clearCaches

public void clearCaches()

Clears all caches.

decode

public Structure decode(ExtensionObject extensionObject)
                 throws DecodingException

Try to decode a Structure, whose serializer is unknown. Note that this operation makes multiple requests to the server and can take a while. Subsequent calls are faster as the data is cached. Cache can be cleared with clearCaches().

Parameters:

extensionObject - the encoded Structure

Returns:

decoded structure

Throws:

DecodingException - if decoding cannot be done

UaException - if typedictionary cannot be read from the server

getDataTypeSpecification

public UaDataTypeSpecification getDataTypeSpecification(UaNodeId id)

Returns an UaDataTypeSpecification that matches the given DataType node id. Returns null if not found or if the given id is not a DataType node.

getEnumerationSpecification

public EnumerationSpecification getEnumerationSpecification(UaNodeId id)

Returns an EnumerationSpecification that matches the given Enumeration DataType node id. Returns null if not found or if the given id is not an Enumeration DataType.

getOptionSetSpecification

public OptionSetSpecification getOptionSetSpecification(UaNodeId id)

Returns a OptionSetSpecification for the given id. The given id can be an encoding or type NodeId. Returns null if there is no StructureSpecification for the given id.

getSimpleTypeSpecification

public SimpleTypeSpecification getSimpleTypeSpecification(UaNodeId id)

Returns an SimpleTypeSpecification that matches the given DataType node id. Returns null if not found or if the given id is not an DataType that classifies as "simple" (i.e. not a Structure, Enumeration nor OptionSet type).

getStructureSpecification

public StructureSpecification getStructureSpecification(UaNodeId id)

Returns a StructureSpecification for the given id. The given id can be an encoding or type NodeId. Returns null if there is no StructureSpecification for the given id.

init

public void init()
          throws TypeDictionaryException

Initializes the TypeDictionary. This method blocks until all dictionaries are resolved, which take some time.

Throws:

TypeDictionaryException - if dictionaries cannot be resolved to StructureSpecifications

init

public void init(boolean shallow)
          throws TypeDictionaryException

Initialize TypeDictionary, on false works the same as init. If given true then does nothing, but the TypeDictionary is considered as initialized.

Throws:

TypeDictionaryException

isUseParallelCalls

public boolean isUseParallelCalls()

Returns true if initialization process can use parallel calls to the server.

refresh

public void refresh()
             throws TypeDictionaryException

Refreshes the dictionary. Clears caches of old definitions and reads new ones from the server. Effectively this method calls clearCaches() and init() after that, therefore this method will block until all DataTypeDictionaries are read and resolved from the server.

Throws:

TypeDictionaryException - if an error happens

setTreatNullDataTypeAsBaseDataType

public void setTreatNullDataTypeAsBaseDataType(boolean treatNullDataTypeAsBaseDataType)

This setting handles a workaround for servers that incorrectly use a Null NodeId instead of having a proper DataTypeId in a StructureField definition of a StructureDefinition in the DataTypeDefinition Attribute. If set it will instead cause the DataType not be parsed. Note that even on true this will cause an WARN level log.

setTreatOpcStringAsOpcCharArray

public void setTreatOpcStringAsOpcCharArray(boolean treatOpcStringAsOpcCharArray)

This setting handles a workaround for servers erroneously describing DataType Strings in the dictionaries as opc:String instead of opc:CharArray and still encoding the data as opc:CharArray. If this setting is true, then all opc:String TypeNames are treated as opc:CharArray TypeNames. This is by default true.

setUseParallelCalls

public void setUseParallelCalls(boolean useParallelCalls)

Set to true if initialization process is allowed to use parallel calls to the server. False by default. Note that in some cases this can make the init faster, but also in some cases it is faster to not use parallel calls. Also some servers might perform better if they are not made.

setWarnOnlyOnErroneousDictionaries

public void setWarnOnlyOnErroneousDictionaries(boolean warnOnlyOnErroneousDictionaries)

This setting handles a workaround for servers erroneously failing to provide proper inverse references from dictionary nodes to the datatype nodes. If set to true, those dictionaries that do not provide proper references are ignored when initializing the dictionary and a warning log is printed instead. Default is false.