com.prosysopc.ua

Class UaNodeSet

java.lang.Object

com.prosysopc.ua.UaNodeSet

public class UaNodeSet
extends Object

Immutable representation of a NodeSet2 XML file's data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaNodeSet.Log An immutable collection of log events.
static class	UaNodeSet.ModelInfo Contains the Models/Model info that is typically at the start of a Nodeset file.
static class	UaNodeSet.NodeData Holds data for a single node.
static class	UaNodeSet.ReferenceData Holds data for a single (in one direction) reference.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAliases() Returns an unmodifiable Map of the Aliases defined in the model.
Set<UaNamespace>	getDependencyNamespaces() Returns OPC UA namespaces this model depends on as an unmodifiable Set.
UaNodeSet.Log	getLog() Returns UaNodeSet.Log that was created during loading.
List<UaNodeSet.ModelInfo>	getModelInfos() Returns unmodifiable list of Model-infos defined in the model.
List<UaNamespace>	getNamespaces() Returns OPC UA namespaces used by the model either as dependency or provided by the model.
Map<UaNodeId,UaNodeSetExtensions>	getNodeExtensions() Returns an unmodifiable Map of node to contents of the Extensions xml element.
Set<UaNodeSet.NodeData>	getNodes() Returns all nodes loaded from the model.
Map<NodeClass,List<UaNodeSet.NodeData>>	getNodesByNodeClass() Convenience method for getNodes() that groups the nodes by NodeClass.
Set<UaNodeSet.NodeData>	getNodesWithLogLevels(UaNodeSet.Log.Event.Level... levels) Returns an unmodifiable Set of all getNodes() that have log of the given levels.
Set<UaNamespace>	getProvidedNamespaces() Returns OPC UA namespaces this model provides on as an unmodifiable Set.
Set<UaNodeSet.ReferenceData>	getReferences() Returns all references loaded from the model.
Set<AddNodesItem>	nodesToAddNodesItem(EncoderContext target) Converts the getNodes() data to AddNodesItem data the context of the given EncoderContext.
static UaNodeSet	parseXml(InputStream modelSource) Parse the given NodeSet2 XML document from the given InputStream to UaNodeSet.
static UaNodeSet	parseXml(InputStream modelSource, Charset charset) Parse the given NodeSet2 XML document from the given InputStream to UaNodeSet using the given Charset.
Set<AddReferencesItem>	referencesToAddReferencesItem(EncoderContext target) Converts the getReferences() data to AddReferencesItem data the context of the given EncoderContext.
String	toXml() Returns the data in NodeSet format.

Methods inherited from class java.lang.Object

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

Method Detail

parseXml

public static UaNodeSet parseXml(InputStream modelSource)
                          throws UaNodeSetException

Parse the given NodeSet2 XML document from the given InputStream to UaNodeSet. Assumes UTF-8 encoding.

Throws:

UaNodeSetException

parseXml

public static UaNodeSet parseXml(InputStream modelSource,
                                 Charset charset)
                          throws UaNodeSetException

Parse the given NodeSet2 XML document from the given InputStream to UaNodeSet using the given Charset. If the given Charset is null, StandardCharsets.UTF_8 is used.

Throws:

UaNodeSetException

getAliases

public Map<String,String> getAliases()

Returns an unmodifiable Map of the Aliases defined in the model. Note that this is for informative use only, the aliases were already replaced during model loading.

getDependencyNamespaces

public Set<UaNamespace> getDependencyNamespaces()

Returns OPC UA namespaces this model depends on as an unmodifiable Set. Specifically, this is the getNamespaces() minus getProvidedNamespaces().

getLog

public UaNodeSet.Log getLog()

Returns UaNodeSet.Log that was created during loading.

getModelInfos

public List<UaNodeSet.ModelInfo> getModelInfos()

Returns unmodifiable list of Model-infos defined in the model. Note that typically there is 0 or 1 entries in the list.

getNamespaces

public List<UaNamespace> getNamespaces()

Returns OPC UA namespaces used by the model either as dependency or provided by the model. Note that this always includes the UaNamespace.STANDARD as the first entry, as every model implicitly has that as the "0 index". Note that the index of the namespaces match the indexes used within the model, but the indexes used by the UaServer are a separate mapping NamespaceTable. The returned List is unmodifiable.

getNodeExtensions

public Map<UaNodeId,UaNodeSetExtensions> getNodeExtensions()

Returns an unmodifiable Map of node to contents of the Extensions xml element.

getNodes

public Set<UaNodeSet.NodeData> getNodes()

Returns all nodes loaded from the model. IMPORTANT! The node data is partially processed in the case for Value and DataType definitions. The returned set is unmodifiable.

getNodesByNodeClass

public Map<NodeClass,List<UaNodeSet.NodeData>> getNodesByNodeClass()

Convenience method for getNodes() that groups the nodes by NodeClass. The returned Map and the Lists within the Map are unmodifiable.

getNodesWithLogLevels

public Set<UaNodeSet.NodeData> getNodesWithLogLevels(UaNodeSet.Log.Event.Level... levels)

Returns an unmodifiable Set of all getNodes() that have log of the given levels. Given null/empty is treated same as UaNodeSet.Log.Event.Level.values(), i.e. returns all UaNodeSet.NodeData that have any log entries. Node-specific log can be obtained via UaNodeSet.NodeData.getLog().

getProvidedNamespaces

public Set<UaNamespace> getProvidedNamespaces()

Returns OPC UA namespaces this model provides on as an unmodifiable Set. A namespace is considered as 'provided' if the model defines a node whose NodeId uses the namespace.

getReferences

public Set<UaNodeSet.ReferenceData> getReferences()

Returns all references loaded from the model. The returned set is unmodifiable.

nodesToAddNodesItem

public Set<AddNodesItem> nodesToAddNodesItem(EncoderContext target)

Converts the getNodes() data to AddNodesItem data the context of the given EncoderContext. IMPORTANT! Calling this method manual is an advanced use-case and shall only be done if this model doesn't define any new DataTypes.

referencesToAddReferencesItem

public Set<AddReferencesItem> referencesToAddReferencesItem(EncoderContext target)

Converts the getReferences() data to AddReferencesItem data the context of the given EncoderContext. IMPORTANT! Calling this method manual is an advanced use-case and shall only be done if this model doesn't define any new DataTypes.

toXml

public String toXml()

Returns the data in NodeSet format.