com.prosysopc.ua.server.nodes

Class UaInstanceNode

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.server.nodes.ServerNode

com.prosysopc.ua.server.nodes.BaseNode

com.prosysopc.ua.server.nodes.UaInstanceNode

All Implemented Interfaces:

UaInstance, UaNode

Direct Known Subclasses:

UaObjectNode, UaVariableNode

public abstract class UaInstanceNode
extends BaseNode
implements UaInstance

Straight forward implementation of UaInstance.

It keeps all attributes in memory.

Note that the OPC UA Specification does not define or represent such a common "base class" for all instance nodes. However, all instance nodes support TypeDefinition reference. In principle UaInstance separates the instance nodes from type nodes, which implement UaType.

Nested Class Summary

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

UaNode.Parameters

Field Summary

Fields inherited from class com.prosysopc.ua.server.nodes.BaseNode

NODE_VERSION_PROPERTY_NAME, useQuickPropertyLookup

Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode

eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaInstanceNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
	UaInstanceNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale)
protected	UaInstanceNode(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
UaReference	addModellingRule(ModellingRule modellingRule) Adds a ModellingRule reference to the node.
protected boolean	beforeAddReference(UaReference reference)
protected abstract ExpandedNodeId	getDefaultTypeDefinition()
UaType	getTypeDefinition() The UaType object corresponding to TypeDefinitionId.
ExpandedNodeId	getTypeDefinitionId() Reference to the NodeId of the object's type definition.
boolean	hasTypeDefinition()
protected UaMethod	registerOverridePlainMethod(String name)
void	setTypeDefinition(UaType type) Sets the type of the node.
void	setTypeDefinitionId(ExpandedNodeId typeDefinitionId) Sets the type definition to an ExpandedNodeId.
void	setTypeDefinitionId(NodeId typeDefinitionId) Sets the type definition to a local NodeId.
protected boolean	supportsTypeDefinitionNode() Defines that the instance supports the TypeDefinition reference to a node, i.e.
String	toString()

Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode

addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getAttributes, getAttributesMap, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeClass, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyReference, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, readAttributeValue, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute, writeAttributeValue

Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode

addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getNodeSetExtensions, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, getUaNodeId, hashCode, initSupportedAttributes, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setNodeSetExtensions, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain

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

getForwardReferences, getInverseReferences, getReferences, getReferences, getUserData, referenceTypeInherits, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Constructor Detail

UaInstanceNode

public UaInstanceNode(NodeManagerUaNode nodeManager,
                      NodeId nodeId,
                      QualifiedName browseName,
                      LocalizedText displayName)

Parameters:

nodeId -

browseName -

displayName -

UaInstanceNode

public UaInstanceNode(NodeManagerUaNode nodeManager,
                      NodeId nodeId,
                      String name,
                      Locale locale)

Parameters:

nodeId -

name -

locale -

UaInstanceNode

protected UaInstanceNode(UaNode.Parameters parameters)

Method Detail

addModellingRule

public UaReference addModellingRule(ModellingRule modellingRule)

Adds a ModellingRule reference to the node. ModellingRules are used in InstanceDeclarations (components and properties of type definitions) to define which of the nodes are mandatory, optional, etc.

Parameters:

modellingRule -

Returns:

the new reference.

getTypeDefinition

public UaType getTypeDefinition()

Description copied from interface: UaInstance

The UaType object corresponding to TypeDefinitionId. Note that the TypeDefinition may be null at certain circumstances although TypeDefinitionId is defined (although it should be implemented generally such that the node is retrieved automatically using TypeDefinitionId).

Specified by:

getTypeDefinition in interface UaInstance

Returns:

the type of the node, if it has such, or null

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.setTypeDefinition(UaType), UaInstance.setTypeDefinitionId(NodeId), UaInstance.setTypeDefinitionId(ExpandedNodeId)

getTypeDefinitionId

public ExpandedNodeId getTypeDefinitionId()

Reference to the NodeId of the object's type definition. Type definitions are only available for the NodeClasses Object and Variable. For all other NodeClasses a null NodeId shall be returned.

Specified by:

getTypeDefinitionId in interface UaInstance

Returns:

the type definition ID of the node. May be null, if no type is defined.

See Also:

UaInstance.getTypeDefinition(), UaInstance.setTypeDefinition(UaType), UaInstance.setTypeDefinitionId(NodeId), UaInstance.setTypeDefinitionId(ExpandedNodeId)

hasTypeDefinition

public boolean hasTypeDefinition()

Overrides:

hasTypeDefinition in class BaseNode

Returns:

setTypeDefinition

public void setTypeDefinition(UaType type)

Sets the type of the node. Also sets typeDefinition, if type is not null. Type definitions are only available for the NodeClasses Object and Variable.

Specified by:

setTypeDefinition in interface UaInstance

Parameters:

type -

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.getTypeDefinition(), UaInstance.setTypeDefinitionId(ExpandedNodeId), UaInstance.setTypeDefinitionId(NodeId)

setTypeDefinitionId

public void setTypeDefinitionId(ExpandedNodeId typeDefinitionId)

Description copied from interface: UaInstance

Sets the type definition to an ExpandedNodeId.

Specified by:

setTypeDefinitionId in interface UaInstance

Parameters:

typeDefinitionId - the type definition Id to set

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.getTypeDefinition(), UaInstance.setTypeDefinition(UaType), UaInstance.setTypeDefinitionId(NodeId)

setTypeDefinitionId

public final void setTypeDefinitionId(NodeId typeDefinitionId)

Description copied from interface: UaInstance

Sets the type definition to a local NodeId.

If

Specified by:

setTypeDefinitionId in interface UaInstance

Parameters:

typeDefinitionId - the type definition Id to set

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.getTypeDefinition(), UaInstance.setTypeDefinition(UaType), UaInstance.setTypeDefinitionId(ExpandedNodeId)

toString

public String toString()

Overrides:

toString in class BaseNode

beforeAddReference

protected boolean beforeAddReference(UaReference reference)

Overrides:

beforeAddReference in class ServerNode

Returns:

getDefaultTypeDefinition

protected abstract ExpandedNodeId getDefaultTypeDefinition()

Returns:

registerOverridePlainMethod

protected UaMethod registerOverridePlainMethod(String name)

Parameters:

name -

Returns:

supportsTypeDefinitionNode

protected boolean supportsTypeDefinitionNode()

Defines that the instance supports the TypeDefinition reference to a node, i.e. setting TypeDefinitionId (which is done by default in init()), also sets the TypeDefinition which creates a UA reference. The problem with the reference is that it inhibits the node from being garbage-collected since there is the reference to the type node.

The events will need to disable this, for instance.

Returns: