com.prosysopc.ua.stack.builtintypes

Class ExpandedNodeId

java.lang.Object

com.prosysopc.ua.stack.builtintypes.ExpandedNodeId

All Implemented Interfaces:

UaNamespaceTranslateable<ExpandedNodeId>, Comparable<ExpandedNodeId>

public final class ExpandedNodeId
extends Object
implements Comparable<ExpandedNodeId>, UaNamespaceTranslateable<ExpandedNodeId>

A NodeId that allows the NamespaceUri to be specified explicitly instead of NamespaceIndex. ExpandedNodeId may still use NamespaceIndex.

equals(Object) should not be used, it exists for historical reasons. NamespaceTable.nodeIdEquals(ExpandedNodeId, ExpandedNodeId) should be used instead, since it can compare NamespaceIndex form with NamespaceURI form.

See Also:

For converting ExpandedNodeIds to NodeIds

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Field Summary

Fields

Modifier and Type	Field and Description
static ExpandedNodeId[]	EMPTY_ARRAY
static NodeId	ID Deprecated. use Identifiers.ExpandedNodeId instead.
static ExpandedNodeId	NULL Constant NULL
static ExpandedNodeId	NULL_GUID Constant NULL_GUID
static ExpandedNodeId	NULL_NUMERIC Considered null node id
static ExpandedNodeId	NULL_OPAQUE Constant NULL_OPAQUE
static ExpandedNodeId	NULL_STRING Constant NULL_STRING

Constructor Summary

Constructors

Constructor and Description
ExpandedNodeId(NodeId nodeId) Convenience constructor that creates a local ExpandedNodeId from the NamespaceIndex and Identifier of a NodeId.
ExpandedNodeId(String namespaceUri, Object value) Convenience constructor that creates ExpandedNodeId from namespaceUri and value.
ExpandedNodeId(UnsignedInteger serverIndex, int namespaceIndex, Object value) Construct ExpandedNodeId using NamespaceIndex.
ExpandedNodeId(UnsignedInteger serverIndex, NodeId nodeId) Convenience constructor that creates ExpandedNodeId from NamespaceIndex and Identifier of an nodeId.
ExpandedNodeId(UnsignedInteger serverIndex, String namespaceUri, Object value) Construct ExpandedNodeId using NamespaceUri.

Method Summary

Modifier and Type	Method and Description
static ExpandedNodeId[]	arrayFrom(UaExpandedNodeId[] nodeIds, ServerTable serverTable) Converts an array of UaExpandedNodeId to an array ofExpandedNodeId in the context of the given NamespaceTable (effectively calling from(UaExpandedNodeId, ServerTable) for each element).
int	compareTo(ExpandedNodeId other)
boolean	equals(NodeId obj) Deprecated. use NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId) instead.
boolean	equals(Object obj) Deprecated. use NamespaceTable.nodeIdEquals(ExpandedNodeId, ExpandedNodeId) instead.
static ExpandedNodeId	from(UaExpandedNodeId nodeId, ServerTable serverTable) Converts the given UaExpandedNodeId to ExpandedNodeId, throws IllegalArgumentException if the given ServerTable doesnt't contain #getServerUri().
static ExpandedNodeId	from(UaNamespace namespace, Object value) Returns an ExpandedNodeId with the given UaNamespace and value.
static ExpandedNodeId	from(UnsignedInteger serverIndex, UaNamespace namespace, Object value) Returns an ExpandedNodeId with the given Server index, UaNamespace and value.
IdType	getIdType() getIdType.
UaNamespace	getNamespace() Returns UaNamespace if this ExpandedNodeId was created using NamespaceUri or UaNamespace (whose UaNamespace.getURI() is then equal to the NamespaceUri).
int	getNamespaceIndex() Get NamespaceIndex if this ExpandedNodeId was constructed with one.
String	getNamespaceUri() Get NamespaceUri if this ExpandedNodeId was constructed with one.
UnsignedInteger	getServerIndex() Getter for the field serverIndex.
Object	getValue() Getter for the field value.
int	hashCode()
boolean	isAbsolute() isAbsolute.
boolean	isLocal() Check if the nodeId refers to a local node, i.e.
static boolean	isNull(ExpandedNodeId nodeId) Check if nodeId is null or a NullNodeId.
boolean	isNullNodeId() Tests whether this node is null node.
static ExpandedNodeId	parseExpandedNodeId(String str) parseExpandedNodeId.
String	toString()
ExpandedNodeId	withTranslatedNamespaces(UaNamespaceTranslateable.Context context) Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL_NUMERIC

public static final ExpandedNodeId NULL_NUMERIC

Considered null node id

NULL_STRING

public static final ExpandedNodeId NULL_STRING

Constant NULL_STRING

NULL_GUID

public static final ExpandedNodeId NULL_GUID

Constant NULL_GUID

NULL_OPAQUE

public static final ExpandedNodeId NULL_OPAQUE

Constant NULL_OPAQUE

NULL

public static final ExpandedNodeId NULL

Constant NULL

ID

@Deprecated
public static final NodeId ID

Deprecated. use Identifiers.ExpandedNodeId instead.

The NodeId for the DataType node ExpandedNodeId in the UA AddressSpace.

EMPTY_ARRAY

public static final ExpandedNodeId[] EMPTY_ARRAY

Constructor Detail

ExpandedNodeId

public ExpandedNodeId(NodeId nodeId)

Convenience constructor that creates a local ExpandedNodeId from the NamespaceIndex and Identifier of a NodeId.

ExpandedNodeId

public ExpandedNodeId(String namespaceUri,
                      Object value)

Convenience constructor that creates ExpandedNodeId from namespaceUri and value. Server index is 0

Parameters:

namespaceUri - a String object.

value - a Object object.

ExpandedNodeId

public ExpandedNodeId(UnsignedInteger serverIndex,
                      int namespaceIndex,
                      Object value)

Construct ExpandedNodeId using NamespaceIndex.

Parameters:

serverIndex - Server Index (optional)

namespaceIndex - namespace index

value - value (must be UnsignedInteger, String, UUID, ByteString or null)

ExpandedNodeId

public ExpandedNodeId(UnsignedInteger serverIndex,
                      NodeId nodeId)

Convenience constructor that creates ExpandedNodeId from NamespaceIndex and Identifier of an nodeId.

Parameters:

serverIndex - Server Index (optional)

nodeId - nodeId

ExpandedNodeId

public ExpandedNodeId(UnsignedInteger serverIndex,
                      String namespaceUri,
                      Object value)

Construct ExpandedNodeId using NamespaceUri.

Parameters:

serverIndex - Server Index (optional)

namespaceUri - a String object.

value - value (must be UnsignedInteger, String, UUID or ByteString)

Method Detail

arrayFrom

public static ExpandedNodeId[] arrayFrom(UaExpandedNodeId[] nodeIds,
                                         ServerTable serverTable)

Converts an array of UaExpandedNodeId to an array ofExpandedNodeId in the context of the given NamespaceTable (effectively calling from(UaExpandedNodeId, ServerTable) for each element). Returns null if given null array. Throws IllegalArgumentException if any individual element conversion fails.

from

public static ExpandedNodeId from(UaExpandedNodeId nodeId,
                                  ServerTable serverTable)

Converts the given UaExpandedNodeId to ExpandedNodeId, throws IllegalArgumentException if the given ServerTable doesnt't contain #getServerUri(). The returned ExpandedNodeId does contain the namespace in uri form. Returns null if given null.

from

public static ExpandedNodeId from(UaNamespace namespace,
                                  Object value)

Returns an ExpandedNodeId with the given UaNamespace and value. Server index is 0.

from

public static ExpandedNodeId from(UnsignedInteger serverIndex,
                                  UaNamespace namespace,
                                  Object value)

Returns an ExpandedNodeId with the given Server index, UaNamespace and value.

isNull

public static boolean isNull(ExpandedNodeId nodeId)

Check if nodeId is null or a NullNodeId.

Parameters:

nodeId - a ExpandedNodeId object.

Returns:

true if (nodeId == null) || nodeId.isNullNodeId()

parseExpandedNodeId

public static ExpandedNodeId parseExpandedNodeId(String str)

parseExpandedNodeId.

Parameters:

str - a String object.

Returns:

a ExpandedNodeId object.

compareTo

public int compareTo(ExpandedNodeId other)

Specified by:

compareTo in interface Comparable<ExpandedNodeId>

equals

@Deprecated
public boolean equals(NodeId obj)

Deprecated. use NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId) instead.

Do not use this method, instead use NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId). For historical reasons equals(Object) in some scenarios has worked with NodeId, but this will be removed in a future version (and the method starts to always return false in this case).

equals

@Deprecated
public boolean equals(Object obj)

Deprecated. use NamespaceTable.nodeIdEquals(ExpandedNodeId, ExpandedNodeId) instead.

Do not use this method, instead use NamespaceTable.nodeIdEquals(ExpandedNodeId, ExpandedNodeId) for comparing 2 ExpandedNodeIds. That can handle scenarios where one of the ExpandedNodeIds has a NamespaceUri and the other has a NamespaceIndex (this method can only check equal-ness assuming both use NamespaceUri or both use NamespaceIndex). Consider using UaNodeId when possible instead of ExpandedNodeId.

Overrides:

equals in class Object

getIdType

public IdType getIdType()

getIdType.

Returns:

a IdType object.

getNamespace

public UaNamespace getNamespace()

Returns UaNamespace if this ExpandedNodeId was created using NamespaceUri or UaNamespace (whose UaNamespace.getURI() is then equal to the NamespaceUri). Returns null if this ExpandedNodeId was created with a NamespaceIndex.

getNamespaceIndex

public int getNamespaceIndex()

Get NamespaceIndex if this ExpandedNodeId was constructed with one.

Returns:

NamespaceIndex

getNamespaceUri

public String getNamespaceUri()

Get NamespaceUri if this ExpandedNodeId was constructed with one.

Returns:

NamespaceUri or null

getServerIndex

public UnsignedInteger getServerIndex()

Getter for the field serverIndex.

Returns:

a UnsignedInteger object.

getValue

public Object getValue()

Getter for the field value.

Returns:

a Object object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAbsolute

public boolean isAbsolute()

isAbsolute.

Returns:

a boolean.

isLocal

public boolean isLocal()

Check if the nodeId refers to a local node, i.e. a node that is in the server's own namespace.

Returns:

a boolean.

isNullNodeId

public boolean isNullNodeId()

Tests whether this node is null node.

Returns:

true if this node is a null node

toString

public String toString()

Overrides:

toString in class Object

withTranslatedNamespaces

public ExpandedNodeId withTranslatedNamespaces(UaNamespaceTranslateable.Context context)

Description copied from interface: UaNamespaceTranslateable

Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context. Returning the same object is allowed if the type is immutable and the result is equal to this. Note that for Structure types if the UaDataTypeSpecification translation is active the returned type can be of different java class.

Specified by:

withTranslatedNamespaces in interface UaNamespaceTranslateable<ExpandedNodeId>