com.prosysopc.ua.nodes

Class AbstractUaNodeFactory

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNodeFactory

All Implemented Interfaces:

UaNodeFactory

Direct Known Subclasses:

UaClientNodeFactory, UaServerNodeFactory

public abstract class AbstractUaNodeFactory
extends Object
implements UaNodeFactory

A base for UaNodeFactory implementations, mostly to be used internally. The current main purpose is internal to inject UaType#setJavaClass(Class) mappings when the UaType nodes are created.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUaNodeFactory(UaAddressSpace context) Creates a new AbstractUaNodeFactory that will use the given context and context class.

Method Summary

Modifier and Type	Method and Description
protected UaNode	createInstance(Function<UaNode.Parameters,? extends UaNode> constructor, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, ExpandedNodeId typeDefinition) Constructs the node using the given Constructor and sets given TypeDefinition or known java class mapping, if applicable.
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, ExpandedNodeId typeDefinition) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, NodeId typeDefinition) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale, ExpandedNodeId typeDefinitionId) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale, NodeId typeDefinitionId) Create a new Node object based on the nodeClass (or typeDefinition).
protected Function<UaNode.Parameters,? extends UaNode>	getConstructor(NodeClass nodeClass, UaNodeId typeId) Tries to find a suitable constructor based on the given NodeClass or TypeDefinition.
protected abstract NamespaceTable	getNamespaceTable()
protected abstract RegisteredClasses	getRegisteredClasses()
protected abstract UaNodeId	getSuperType(UaNodeId typeId) Return super type of the given type, or null if none.
<T extends UaNode> void	registerNodeClass(NodeClass nodeClass, Function<UaNode.Parameters,T> constructor)
<T extends UaNode> void	registerTypeDefinition(UaNodeId typeDefinition, Function<UaNode.Parameters,T> constructor)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUaNodeFactory

protected AbstractUaNodeFactory(UaAddressSpace context)

Creates a new AbstractUaNodeFactory that will use the given context and context class. The context is equal to the first constructor parameter of the UaNode implementations this factory will make. In practice this is either client or server side UaAddressSpace implementation.

Method Detail

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         QualifiedName browseName,
                         LocalizedText displayName)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using UaNodeFactory.registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Specified by:

createNode in interface UaNodeFactory

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         QualifiedName browseName,
                         LocalizedText displayName,
                         ExpandedNodeId typeDefinition)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using UaNodeFactory.registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Specified by:

createNode in interface UaNodeFactory

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

typeDefinition - Optional type definition to use for the class selection.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         QualifiedName browseName,
                         LocalizedText displayName,
                         NodeId typeDefinition)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using UaNodeFactory.registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Specified by:

createNode in interface UaNodeFactory

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

typeDefinition - Optional type definition to use for the class selection.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         String name,
                         Locale locale)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using UaNodeFactory.registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Specified by:

createNode in interface UaNodeFactory

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

name - The name of the new node. The BrowseName and DisplayName are initialized to this.

locale - The locale to use for the DisplayName.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         String name,
                         Locale locale,
                         ExpandedNodeId typeDefinitionId)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using UaNodeFactory.registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Specified by:

createNode in interface UaNodeFactory

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

name - The name of the new node. The BrowseName and DisplayName are initialized to this.

locale - The locale to use for the DisplayName.

typeDefinitionId - The type definition of the node to create. If there is a specific class registered with the type, a node object of that type is created.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

public UaNode createNode(NodeClass nodeClass,
                         NodeId nodeId,
                         String name,
                         Locale locale,
                         NodeId typeDefinitionId)
                  throws UaNodeFactoryException

Description copied from interface: UaNodeFactory

Create a new Node object based on the nodeClass (or typeDefinition).

Specified by:

createNode in interface UaNodeFactory

Throws:

UaNodeFactoryException

See Also:

UaNodeFactory.createNode(NodeClass, NodeId, QualifiedName, LocalizedText, ExpandedNodeId)

registerNodeClass

public <T extends UaNode> void registerNodeClass(NodeClass nodeClass,
                                                 Function<UaNode.Parameters,T> constructor)
                                          throws UaNodeFactoryException

Specified by:

registerNodeClass in interface UaNodeFactory

Throws:

UaNodeFactoryException

registerTypeDefinition

public <T extends UaNode> void registerTypeDefinition(UaNodeId typeDefinition,
                                                      Function<UaNode.Parameters,T> constructor)
                                               throws UaNodeFactoryException

Specified by:

registerTypeDefinition in interface UaNodeFactory

Throws:

UaNodeFactoryException

createInstance

protected UaNode createInstance(Function<UaNode.Parameters,? extends UaNode> constructor,
                                NodeId nodeId,
                                QualifiedName browseName,
                                LocalizedText displayName,
                                ExpandedNodeId typeDefinition)
                         throws UaNodeFactoryException

Constructs the node using the given Constructor and sets given TypeDefinition or known java class mapping, if applicable.

Throws:

UaNodeFactoryException

getConstructor

protected Function<UaNode.Parameters,? extends UaNode> getConstructor(NodeClass nodeClass,
                                                                      UaNodeId typeId)

Tries to find a suitable constructor based on the given NodeClass or TypeDefinition. If no direct mapping exists for a TypeDefinition, uses supertypes (recursively).

getNamespaceTable

protected abstract NamespaceTable getNamespaceTable()

getRegisteredClasses

protected abstract RegisteredClasses getRegisteredClasses()

getSuperType

protected abstract UaNodeId getSuperType(UaNodeId typeId)
                                  throws Exception

Return super type of the given type, or null if none. Throws on error.

Throws:

Exception