com.prosysopc.ua.server.nodes

Class UaServerReference

java.lang.Object

com.prosysopc.ua.nodes.UaReference

com.prosysopc.ua.server.nodes.UaServerReference

All Implemented Interfaces:

Comparable<UaReference>

public class UaServerReference
extends UaReference

UA reference implementation for the server side.

Constructor Summary

Constructors

Constructor and Description
UaServerReference(NodeId referenceTypeId, UaNode sourceNode, UaNode targetNode)
UaServerReference(UaReferenceType referenceType, UaNode sourceNode, UaNode targetNode)

Method Summary

Modifier and Type	Method and Description
int	compareTo(UaReference o)
void	delete()
boolean	equals(Object obj)
boolean	getIsInverse(NodeId nodeId)
boolean	getIsInverse(UaNode node) Whether the reference is a forward or inverse reference.
UaNode	getOppositeNode(UaNode node) Get the other end of the reference.
static UaServerReference	getReferenceInstance(NodeId referenceTypeId, UaNode sourceNode, UaNode targetNode) Returns an existing reference, or creates and returns a new one if one didn't already exist.
static UaServerReference	getReferenceInstance(UaReferenceType referenceType, UaNode sourceNode, UaNode targetNode) Returns an existing reference, or creates and returns a new one if one didn't already exist.
UaReferenceType	getReferenceType() Get the ReferenceType node, if defined.
NodeId	getReferenceTypeId()
ExpandedNodeId	getSourceId() NodeId of the SourceNode as assigned by the Server identified by the Server index.
UaNode	getSourceNode()
ExpandedNodeId	getTargetId() NodeId of the TargetNode as assigned by the Server identified by the Server index.
UaNode	getTargetNode() Reference to the target node object.
int	hashCode()
boolean	isHasProperty() Returns true if UaReference.getReferenceTypeId() is equals to ReferenceTypeIdentifiers.HasProperty, false otherwise.
boolean	isSymmetric()
String	toString()

Methods inherited from class com.prosysopc.ua.nodes.UaReference

getOppositeNodeId

Methods inherited from class java.lang.Object

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

Constructor Detail

UaServerReference

public UaServerReference(NodeId referenceTypeId,
                         UaNode sourceNode,
                         UaNode targetNode)

UaServerReference

public UaServerReference(UaReferenceType referenceType,
                         UaNode sourceNode,
                         UaNode targetNode)

Method Detail

getReferenceInstance

public static UaServerReference getReferenceInstance(NodeId referenceTypeId,
                                                     UaNode sourceNode,
                                                     UaNode targetNode)

Returns an existing reference, or creates and returns a new one if one didn't already exist.

getReferenceInstance

public static UaServerReference getReferenceInstance(UaReferenceType referenceType,
                                                     UaNode sourceNode,
                                                     UaNode targetNode)

Returns an existing reference, or creates and returns a new one if one didn't already exist.

compareTo

public int compareTo(UaReference o)

Specified by:

compareTo in interface Comparable<UaReference>

Overrides:

compareTo in class UaReference

delete

public void delete()

Specified by:

delete in class UaReference

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getIsInverse

public boolean getIsInverse(NodeId nodeId)

Specified by:

getIsInverse in class UaReference

Returns:

getIsInverse

public boolean getIsInverse(UaNode node)

Whether the reference is a forward or inverse reference.

Specified by:

getIsInverse in class UaReference

Returns:

true if the reference is an inverse reference.

getOppositeNode

public UaNode getOppositeNode(UaNode node)

Description copied from class: UaReference

Get the other end of the reference.

Overrides:

getOppositeNode in class UaReference

Parameters:

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

Returns:

the targetNode or sourceNode depending on which one node is

getReferenceType

public UaReferenceType getReferenceType()

Get the ReferenceType node, if defined. ReferenceTypeId is always defined, but the corresponding type node might not be available.

Specified by:

getReferenceType in class UaReference

Returns:

the referenceType node.

getReferenceTypeId

public NodeId getReferenceTypeId()

Specified by:

getReferenceTypeId in class UaReference

Returns:

NodeId of the ReferenceType that defines the Reference.

See Also:

getReferenceType()

getSourceId

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

Specified by:

getSourceId in class UaReference

Returns:

The NodeId of the reference source.

getSourceNode

public UaNode getSourceNode()

Specified by:

getSourceNode in class UaReference

Returns:

getTargetId

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

Specified by:

getTargetId in class UaReference

Returns:

The NodeId of the reference target.

getTargetNode

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

Specified by:

getTargetNode in class UaReference

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isHasProperty

public boolean isHasProperty()

Description copied from class: UaReference

Returns true if UaReference.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.

Overrides:

isHasProperty in class UaReference

isSymmetric

public boolean isSymmetric()

Returns:

toString

public String toString()

Overrides:

toString in class UaReference