com.prosysopc.ua.nodes

Class AbstractUaNode

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

All Implemented Interfaces:

UaNode

Direct Known Subclasses:

ServerNode, UaNodeImpl

public abstract class AbstractUaNode
extends Object
implements UaNode

Internal abstract base class for client and server side UaNode implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

UaNode.Parameters

Constructor Summary

Constructors

Constructor and Description
AbstractUaNode()

Method Summary

Modifier and Type	Method and Description
UaReference[]	getForwardReferences(NodeId... referenceTypeIds) Get all forward references of this node.
UaReference[]	getInverseReferences(NodeId... referenceTypeIds) Get all inverse references of this node.
protected abstract Collection<UaReference>	getReferenceList() Returns all references the node has.
UaReference[]	getReferences() Returns all references of the Node.
protected UaReference[]	getReferences(boolean isInverse, NodeId... referenceTypeIds)
protected List<UaReference>	getReferencesAsList(Boolean isInverse, NodeId... referenceTypeIds)
Object	getUserData() Returns the user data for the UaNode.
protected abstract boolean	referenceTypeInherits(NodeId referenceTypeTypeId, NodeId... referenceTypeIds) Checks if the given reference type inherits from any of the defined types.
protected boolean	referenceTypeInherits(UaReferenceType referenceType, NodeId... referenceTypeIds) Checks if the given reference type inherits from any of the defined types.
void	setUserData(Object userData) Sets the user data for the UaNode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getMethod, getNodeClass, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Constructor Detail

AbstractUaNode

public AbstractUaNode()

Method Detail

getForwardReferences

public UaReference[] getForwardReferences(NodeId... referenceTypeIds)

Description copied from interface: UaNode

Get all forward references of this node.

Specified by:

getForwardReferences in interface UaNode

Parameters:

referenceTypeIds - the reference types that are used to filter the set.

Returns:

an array of references

See Also:

UaNode.getInverseReferences(NodeId...), UaNode.getReferences(NodeId, boolean), UaNode.getReferences(), UaNode.getReference(NodeId, boolean)

getInverseReferences

public UaReference[] getInverseReferences(NodeId... referenceTypeIds)

Description copied from interface: UaNode

Get all inverse references of this node.

Specified by:

getInverseReferences in interface UaNode

Parameters:

referenceTypeIds - the reference types that are used to filter the set.

Returns:

an array of references. Note that the TargetNode of all references is this node, and SourceNode is the other end.

See Also:

UaNode.getForwardReferences(NodeId...), UaNode.getReferences(NodeId, boolean), UaNode.getReferences(), UaNode.getReference(NodeId, boolean)

getReferences

public UaReference[] getReferences()

Description copied from interface: UaNode

Returns all references of the Node.

Specified by:

getReferences in interface UaNode

Returns:

an array of references of the node. If there are no references, returns an empty array

getUserData

public Object getUserData()

Description copied from interface: UaNode

Returns the user data for the UaNode.

Note, that the user data is tied to the UaNode instance. On Client side new UaNode instances are created when getting Nodes via UaAddressSpace.getNode and cached instances have expired. Therefore, the caller of getUserData and UaNode.setUserData(java.lang.Object) methods must make sure the same UaNode instance is used when calling the methods.

Specified by:

getUserData in interface UaNode

Returns:

the user data for the UaNode

setUserData

public void setUserData(Object userData)

Description copied from interface: UaNode

Sets the user data for the UaNode.

Note, that the user data is tied to the UaNode instance. On Client side new UaNode instances are created when getting Nodes via UaAddressSpace.getNode and cached instances have expired. Therefore, the caller of UaNode.getUserData() and setUserData methods must make sure the same UaNode instance is used when calling the methods.

Specified by:

setUserData in interface UaNode

Parameters:

userData - the user data

getReferenceList

protected abstract Collection<UaReference> getReferenceList()

Returns all references the node has.

getReferences

protected UaReference[] getReferences(boolean isInverse,
                                      NodeId... referenceTypeIds)

getReferencesAsList

protected List<UaReference> getReferencesAsList(Boolean isInverse,
                                                NodeId... referenceTypeIds)

referenceTypeInherits

protected abstract boolean referenceTypeInherits(NodeId referenceTypeTypeId,
                                                 NodeId... referenceTypeIds)

Checks if the given reference type inherits from any of the defined types. This method should only be used for References filtering purposes. Returns true regardless of given type to check in case the array of root types to check is null or empty OR contains a single entry that is null or equal to the literal 'References' ReferenceType.

referenceTypeInherits

protected boolean referenceTypeInherits(UaReferenceType referenceType,
                                        NodeId... referenceTypeIds)

Checks if the given reference type inherits from any of the defined types. This method should only be used for References filtering purposes. Returns true regardless of given type to check in case the array of root types to check is null or empty OR contains a single entry that is null or equal to the literal 'References' ReferenceType.