com.prosysopc.ua

Class UaQualifiedName

java.lang.Object

com.prosysopc.ua.UaQualifiedName

All Implemented Interfaces:

UaNamespaceTranslateable<UaQualifiedName>, Comparable<UaQualifiedName>

public class UaQualifiedName
extends Object
implements Comparable<UaQualifiedName>, UaNamespaceTranslateable<UaQualifiedName>

A class similar to QualifiedName that uses NamespaceUri instead of index. Can be converted to normal QualifiedName via toQualifiedName(NamespaceTable) in the context of a NamespaceTable.

Nested Class Summary

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

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
static UaQualifiedName[]	arrayFrom(QualifiedName[] qualifiedNames, NamespaceTable namespaceTable) Converts an array of QualifiedName to an array ofUaQualifiedName in the context of the given NamespaceTable.
int	compareTo(UaQualifiedName other)
boolean	equals(Object obj)
static UaQualifiedName	from(QualifiedName qualifiedName, NamespaceTable namespaceTable) Converts a QualifiedName to UaQualifiedName in the context of a NamespaceTable.
static UaQualifiedName	from(String namespaceUri, String name) Creates an UaQualifiedName with the given NamespaceUri and name parts.
static UaQualifiedName	from(UaNamespace namespace, String name) Creates an UaQualifiedName with the given namespace and name parts.
String	getName() Get the name part of this QualifiedName.
UaNamespace	getNamespace() Returns the namespace part of this QualifiedName.
String	getNamespaceUri() Get the namespace part of this QualifiedName.
int	hashCode()
static UaQualifiedName	parse(String encodedUaQualifiedName) Returns UaQualifiedName that matches the given encoded from that was previously returned by toString().
static UaQualifiedName	standard(String name) Creates a new UaQualifiedName for a name in the OPC UA Standard namepsace.
QualifiedName	toQualifiedName(NamespaceTable namespaceTable) Convert this to QualifiedName that can be used in ServiceRequests.
String	toString()
UaQualifiedName	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

Method Detail

arrayFrom

public static UaQualifiedName[] arrayFrom(QualifiedName[] qualifiedNames,
                                          NamespaceTable namespaceTable)

Converts an array of QualifiedName to an array ofUaQualifiedName in the context of the given NamespaceTable. Returns null if given null array.

from

public static UaQualifiedName from(QualifiedName qualifiedName,
                                   NamespaceTable namespaceTable)

Converts a QualifiedName to UaQualifiedName in the context of a NamespaceTable. Returns null if given null. Throws IllegalArgumentException if given null NamespaceTable.

from

public static UaQualifiedName from(String namespaceUri,
                                   String name)

Creates an UaQualifiedName with the given NamespaceUri and name parts.

Parameters:

namespaceUri - the NamespaceUri part

name - the name part, null String is converted to an empty String.

Returns:

an UaQualifiedName with the given namespaceUri and name.

Throws:

IllegalArgumentException - namespaceUri is null

from

public static UaQualifiedName from(UaNamespace namespace,
                                   String name)

Creates an UaQualifiedName with the given namespace and name parts.

parse

public static UaQualifiedName parse(String encodedUaQualifiedName)

Returns UaQualifiedName that matches the given encoded from that was previously returned by toString(). That is 'nsu=namespaceuri;name=namedata' where getNamespaceUri() is encoded similar to ExpandedNodeId.toString().Returns null if given null.

standard

public static UaQualifiedName standard(String name)

Creates a new UaQualifiedName for a name in the OPC UA Standard namepsace. Equals to UaQualifiedName.from(NamespaceTable.OPCUA_NAMESPACE, name)

Parameters:

name - the name

Returns:

the respective qualifiedName

compareTo

public int compareTo(UaQualifiedName other)

Specified by:

compareTo in interface Comparable<UaQualifiedName>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getName

public String getName()

Get the name part of this QualifiedName.

Returns:

the name part

getNamespace

public UaNamespace getNamespace()

Returns the namespace part of this QualifiedName.

getNamespaceUri

public String getNamespaceUri()

Get the namespace part of this QualifiedName.

Returns:

the namespace part as uri

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toQualifiedName

public QualifiedName toQualifiedName(NamespaceTable namespaceTable)

Convert this to QualifiedName that can be used in ServiceRequests.

Parameters:

namespaceTable - a NamespaceTable, must contain entry for getNamespaceUri()

Returns:

QualifiedName that has getNamespaceUri() transformed to index

Throws:

IllegalArgumentException - if the given namespacetable is null or does not contain entry

toString

public String toString()

Overrides:

toString in class Object

withTranslatedNamespaces

public UaQualifiedName 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<UaQualifiedName>