com.prosysopc.ua.stack.common

Class NamespaceTable

java.lang.Object

com.prosysopc.ua.stack.builtintypes.InternalNodeIdUtilAccessor

com.prosysopc.ua.stack.common.UriTable<UaNamespace>

com.prosysopc.ua.stack.common.NamespaceTable

public class NamespaceTable
extends UriTable<UaNamespace>

The table of name space URIs for a server. The table enables mapping between name space indexes and URIs. The OPCUA_NAMESPACE is always in index 0. NOTE! Each "context" can have a different mapping table i.e. when loading NodeSet2 XMLs, the model has it's own mapping table, whose indexes differ form the server NamespaceArray node mappings (which are also typically represented by a NamespaceTable by the SDK).

Use UriTable.add(int, java.lang.String) to add entries to the table. Use getIndex(java.lang.String) to find the index of an URI or UriTable.getUri(int) to find the Uri of an index.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPCUA_NAMESPACE The core NamespaceUri of the base specification of OPC UA, which is always in NamespaceIndex 0.

Constructor Summary

Constructors

Constructor and Description
NamespaceTable() Constructor for NamespaceTable.

Method Summary

Modifier and Type	Method and Description
boolean	contains(UaNamespace namespace) Returns true if this NamespaceTable contains a mapping for the given UaNamespace, false otherwise.
static NamespaceTable	createFromArray(String[] namespaceArray) createFromArray.
static NamespaceTable	getDefaultInstance() Getter for the field defaultInstance.
int	getIndex(String namespaceUri) Finds the index of the namespace URI in the table.
UaNamespace	getNamespace(int namespaceIndex) Returns UaNamespace that matches the given index in this table, null if there is no mapping.
UaNamespace	getNamespace(String namespaceUri) Returns UaNamespace that has the given NamespaceUri, if this table contains an index mapping for that uri, otherwise returns null.
boolean	namespaceEquals(ExpandedNodeId expandedNodeId1, ExpandedNodeId expandedNodeId2) Check if the node IDs refer to the same name space.
boolean	namespaceEquals(NodeId nodeId, ExpandedNodeId expandedNodeId) Check if the node IDs refer to the same name space.
boolean	namespaceEquals(NodeId nodeId1, NodeId nodeId2) Check if the node IDs refer to the same name space.
boolean	nodeIdEquals(ExpandedNodeId n1, ExpandedNodeId n2) Compare 2 ExpandedNodeId objects.
boolean	nodeIdEquals(NodeId n1, ExpandedNodeId n2) Compare 1 ExpandedNodeId and 1 NodeId.
ExpandedNodeId	toExpandedNodeId(NodeId nodeId) Convert the NodeId to an ExpandedNodeId using the namespaceUris of the table.
NodeId	toNodeId(ExpandedNodeId expandedNodeId) Convert the expandedNodeId to a NodeId using the name space indexes of the table.

Methods inherited from class com.prosysopc.ua.stack.common.UriTable

add, add, addAll, containsObject, getObjectByIndex, getObjectByUri, getUri, remove, remove, size, toArray, toString

Methods inherited from class com.prosysopc.ua.stack.builtintypes.InternalNodeIdUtilAccessor

getNodeIdWithPreCalcHashCode

Methods inherited from class java.lang.Object

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

Field Detail

OPCUA_NAMESPACE

public static final String OPCUA_NAMESPACE

The core NamespaceUri of the base specification of OPC UA, which is always in NamespaceIndex 0.

See Also:

Constant Field Values

Constructor Detail

NamespaceTable

public NamespaceTable()

Constructor for NamespaceTable.

Method Detail

createFromArray

public static NamespaceTable createFromArray(String[] namespaceArray)

createFromArray.

Parameters:

namespaceArray - an array of String objects.

Returns:

a NamespaceTable object.

getDefaultInstance

public static NamespaceTable getDefaultInstance()

Getter for the field defaultInstance.

Returns:

a default instance which can be used when no other namespace table is available. DO NOT use, if you have a valid application context with an initialized namespace table available.

contains

public boolean contains(UaNamespace namespace)

Returns true if this NamespaceTable contains a mapping for the given UaNamespace, false otherwise.

getIndex

public int getIndex(String namespaceUri)

Description copied from class: UriTable

Finds the index of the namespace URI in the table.

Overrides:

getIndex in class UriTable<UaNamespace>

Parameters:

namespaceUri - the URI of the namespace you are looking for

Returns:

the index of the URI or -1, if it is not in the table

getNamespace

public UaNamespace getNamespace(int namespaceIndex)

Returns UaNamespace that matches the given index in this table, null if there is no mapping.

getNamespace

public UaNamespace getNamespace(String namespaceUri)

Returns UaNamespace that has the given NamespaceUri, if this table contains an index mapping for that uri, otherwise returns null.

namespaceEquals

public boolean namespaceEquals(ExpandedNodeId expandedNodeId1,
                               ExpandedNodeId expandedNodeId2)

Check if the node IDs refer to the same name space. The expandedNodeIds are checked for the NamespaceUri or Index depending on which is used.

Parameters:

expandedNodeId1 - a ExpandedNodeId object.

expandedNodeId2 - a ExpandedNodeId object.

Returns:

true if the nodes are in the same name space

Throws:

ServiceResultException - if uris within the ids could not be converted to indexes.

namespaceEquals

public boolean namespaceEquals(NodeId nodeId,
                               ExpandedNodeId expandedNodeId)

Check if the node IDs refer to the same name space. The expandedNodeId is checked for the NamespaceUri or Index depending on which is used.

Parameters:

nodeId - a NodeId object.

expandedNodeId - a ExpandedNodeId object.

Returns:

true if the nodes are in the same name space

Throws:

ServiceResultException - if uris within the ids could not be converted to indexes

namespaceEquals

public boolean namespaceEquals(NodeId nodeId1,
                               NodeId nodeId2)

Check if the node IDs refer to the same name space. Compares the NamespaceIndex of the IDs.

Parameters:

nodeId1 - a NodeId object.

nodeId2 - a NodeId object.

Returns:

true if the nodes are in the same name space

nodeIdEquals

public boolean nodeIdEquals(ExpandedNodeId n1,
                            ExpandedNodeId n2)

Compare 2 ExpandedNodeId objects. This method is intended for cases where one ExpandedNodeId is defined with NamespaceUri and another is defined with NamespaceIndex.

Parameters:

n1 - first

n2 - second

Returns:

true if they are equal

Throws:

ServiceResultException - if uris cannot be converted to indexes

nodeIdEquals

public boolean nodeIdEquals(NodeId n1,
                            ExpandedNodeId n2)

Compare 1 ExpandedNodeId and 1 NodeId. This method is intended for cases where the ExpandedNodeId is defined with NamespaceUri and a comparison to NodeId which has NamespaceIndex is wanted.

Parameters:

n1 - first

n2 - second

Returns:

true if they are equal

Throws:

ServiceResultException - if uris cannot be converted to indexes

toExpandedNodeId

public ExpandedNodeId toExpandedNodeId(NodeId nodeId)

Convert the NodeId to an ExpandedNodeId using the namespaceUris of the table. NOTE! If the mapping is not found then a placeholder uri is used instead that allows the returned object to be converted to a NodeId using the toNodeId(ExpandedNodeId) method.

Parameters:

nodeId - the NodeId to convert

Returns:

The respective ExpandedNodeId having the NamespaceUri from the mapping

toNodeId

public NodeId toNodeId(ExpandedNodeId expandedNodeId)
                throws ServiceResultException

Convert the expandedNodeId to a NodeId using the name space indexes of the table.

Parameters:

expandedNodeId - the expanded node ID

Returns:

The respective NodeId

Throws:

ServiceResultException - if there is no entry for the namespaceUri used in the expandedNodeId