com.prosysopc.ua.nodes

Class UaReference

java.lang.Object

com.prosysopc.ua.nodes.UaReference

All Implemented Interfaces:

Comparable<UaReference>

Direct Known Subclasses:

UaClientReference, UaServerReference

public abstract class UaReference
extends Object
implements Comparable<UaReference>

This class models a Reference between 2 OPC UA Nodes.

Constructor Summary

Constructors

Constructor and Description
UaReference()

Method Summary

Modifier and Type	Method and Description
int	compareTo(UaReference o)
abstract void	delete()
abstract boolean	getIsInverse(NodeId nodeId)
abstract boolean	getIsInverse(UaNode node) Whether the reference is a forward or inverse reference.
UaNode	getOppositeNode(UaNode node) Get the other end of the reference.
ExpandedNodeId	getOppositeNodeId(ExpandedNodeId nodeId) Get the NodeId of the other end of the reference.
abstract UaReferenceType	getReferenceType() Get the ReferenceType node, if defined.
abstract NodeId	getReferenceTypeId()
abstract ExpandedNodeId	getSourceId() NodeId of the SourceNode as assigned by the Server identified by the Server index.
abstract UaNode	getSourceNode()
abstract ExpandedNodeId	getTargetId() NodeId of the TargetNode as assigned by the Server identified by the Server index.
abstract UaNode	getTargetNode() Reference to the target node object.
boolean	isHasProperty() Returns true if getReferenceTypeId() is equals to ReferenceTypeIdentifiers.HasProperty, false otherwise.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UaReference

public UaReference()

Method Detail

compareTo

public int compareTo(UaReference o)

Specified by:

compareTo in interface Comparable<UaReference>

delete

public abstract void delete()

getIsInverse

public abstract boolean getIsInverse(NodeId nodeId)

Parameters:

nodeId -

Returns:

getIsInverse

public abstract boolean getIsInverse(UaNode node)

Whether the reference is a forward or inverse reference.

Returns:

true if the reference is an inverse reference.

getOppositeNode

public UaNode getOppositeNode(UaNode node)

Get the other end of the reference.

Parameters:

node - the node from which the other node is looked from.

Returns:

the targetNode or sourceNode depending on which one node is

getOppositeNodeId

public ExpandedNodeId getOppositeNodeId(ExpandedNodeId nodeId)

Get the NodeId of the other end of the reference.

Parameters:

nodeId - the node from which the other node is looked from.

Returns:

the targetNode or sourceNode depending on which one node is

getReferenceType

public abstract UaReferenceType getReferenceType()

Get the ReferenceType node, if defined. ReferenceTypeId is always defined, but the type is not necessarily. Use #setReferenceType(UaReferenceType) to define it.

Returns:

the referenceType node.

getReferenceTypeId

public abstract NodeId getReferenceTypeId()

Returns:

NodeId of the ReferenceType that defines the Reference.

See Also:

getReferenceType()

getSourceId

public abstract ExpandedNodeId getSourceId()

NodeId of the SourceNode as assigned by the Server identified by the Server index.

If the serverIndex indicates that the SourceNode is a remote Node, then the nodeId shall contain the absolute namespace URI. If the SourceNode is a local Node the nodeId shall contain the namespace index. If SourceNode is defined, this will be equal to the NodeId of that.

Returns:

The NodeId of the reference source.

getSourceNode

public abstract UaNode getSourceNode()

Returns:

getTargetId

public abstract ExpandedNodeId getTargetId()

NodeId of the TargetNode as assigned by the Server identified by the Server index.

If the serverIndex indicates that the TargetNode is a remote Node, then the nodeId shall contain the absolute namespace URI. If the TargetNode is a local Node the nodeId shall contain the namespace index. If TargetNode is defined, this will be equal to the NodeId of that.

Returns:

The NodeId of the reference target.

getTargetNode

public abstract UaNode getTargetNode()

Reference to the target node object. The object may also be null, in which case, the targetNodeId defines the target of the reference.

Returns:

isHasProperty

public boolean isHasProperty()

Returns true if getReferenceTypeId() is equals to ReferenceTypeIdentifiers.HasProperty, false otherwise. Note that this is mostly for internal optimization purposes for subtypes, as this check happens extremely often.

toString

public String toString()

Overrides:

toString in class Object