com.prosysopc.ua.server.instantiation
Class NodeBuilderConfiguration

java.lang.Object
  extended by com.prosysopc.ua.server.instantiation.AbstractNodeBuilderConfiguration
      extended by com.prosysopc.ua.server.instantiation.NodeBuilderConfiguration
All Implemented Interfaces:
UaNodeBuilderConfiguration
Direct Known Subclasses:
DefaultNodeBuilderConfiguration

public class NodeBuilderConfiguration
extends AbstractNodeBuilderConfiguration

* A NodeBuilderConfiguration that can be defined using NodeIds or BrowsePaths.

The configuration is used to define how the NodeBuilder should create the instance, in practice it defines which optional members should be created to new nodes.

The nodes to build are defined with the NodeIds or BrowsePaths of the respective instance declarations (members) in the type definition.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.prosysopc.ua.server.instantiation.AbstractNodeBuilderConfiguration
AbstractNodeBuilderConfiguration.InternalBrowsePath, AbstractNodeBuilderConfiguration.InternalEntry, AbstractNodeBuilderConfiguration.InternalExpandedNodeId, AbstractNodeBuilderConfiguration.InternalNodeId
 
Nested classes/interfaces inherited from interface com.prosysopc.ua.server.instantiation.UaNodeBuilderConfiguration
UaNodeBuilderConfiguration.InstantiationStrategySearchParameters
 
Field Summary
 
Fields inherited from interface com.prosysopc.ua.server.instantiation.UaNodeBuilderConfiguration
DEFAULT_INSTANTIATION_STRATEGY
 
Constructor Summary
NodeBuilderConfiguration()
           
 
Method Summary
 NodeBuilderConfiguration addOptional(BrowsePath path)
          Adds a new optional member to the list of nodes to be created.
 NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId)
          Mark an Optional node to be instantiated during node building.
 NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.NodeId id)
          Mark this NodeId to be constructed.
 NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.QualifiedName... qualifiedName)
          Adds a new optional member to the list of nodes to be created.
 NodeBuilderConfiguration addOptional(String name)
          Adds a new optional member to the list of nodes to be created.
 NodeBuilderConfiguration addOptional(String name, int namespaceIndex)
          Adds a new optional member to the list of nodes to be created.
 AbstractNodeBuilderConfiguration addSubConfiguration(UaNodeBuilderConfiguration config)
          Add an additional "function".
protected  List<AbstractNodeBuilderConfiguration.InternalEntry> getInternalEntries(UaNodeBuilderConfiguration.InstantiationStrategySearchParameters parameters)
           
 NodeBuilderConfiguration setCallbackInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId, UaVariableCallback callback)
           
 NodeBuilderConfiguration setCallbackInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId, UaVariableCallback callback)
           
 NodeBuilderConfiguration setInstantiationStrategy(BrowsePath path, InstantiationStrategy strategy)
          Set an InstantiationStrategy for a given BrowsePath.
 NodeBuilderConfiguration setInstantiationStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId, InstantiationStrategy strategy)
           
 NodeBuilderConfiguration setInstantiationStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId, InstantiationStrategy strategy)
           
 NodeBuilderConfiguration setPlainInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationPropertyId)
           
 NodeBuilderConfiguration setPlainInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationPropertyId)
           
 NodeBuilderConfiguration setReflectiveInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationPropertyId)
           
 NodeBuilderConfiguration setReflectiveInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationPropertyId)
           
 NodeBuilderConfiguration setTwoStateVariableStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId, String trueState, String falseState, boolean defaultValue)
           
 NodeBuilderConfiguration setTwoStateVariableStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId, String trueState, String falseState, boolean defaultValue)
           
 
Methods inherited from class com.prosysopc.ua.server.instantiation.AbstractNodeBuilderConfiguration
getInstantiationStrategy, removeInstantiationStrategy, setInstantiationStrategy, setInstantiationStrategyIfNotPresent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeBuilderConfiguration

public NodeBuilderConfiguration()
Method Detail

addOptional

public NodeBuilderConfiguration addOptional(BrowsePath path)
Adds a new optional member to the list of nodes to be created.

Parameters:
path - The complete BrowsePath to the sub node.
Returns:
this configuration object

addOptional

public NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId)
Mark an Optional node to be instantiated during node building. NOTE! if the InstanceDeclarationId has an InstantiationStategy, it is automatically created during node building.

Parameters:
instanceDeclarationId - NOTE! the give ExpandedNodeId must have NamespaceUri

addOptional

public NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.NodeId id)
Mark this NodeId to be constructed.


addOptional

public NodeBuilderConfiguration addOptional(org.opcfoundation.ua.builtintypes.QualifiedName... qualifiedName)
Adds a new optional member to the list of nodes to be created.

Parameters:
qualifiedName - the QualifiedName of the direct sub node.
Returns:
this configuration object

addOptional

public NodeBuilderConfiguration addOptional(String name)
Adds a new optional member to the list of nodes to be created.

Parameters:
name - the name of the standard member. This must refer to a member name in the standard (OPC UA) namespace. If you wish to define a name in another namespace, use another overloaded version of the method.
Returns:
this configuration object

addOptional

public NodeBuilderConfiguration addOptional(String name,
                                            int namespaceIndex)
Adds a new optional member to the list of nodes to be created. Creates a QualifiedName using the namespaceIndex and name to be used with #addOptional(QualifiedName).

Parameters:
name - the name of the direct sub node.
namespaceIndex - the namespace of the sub node. Default is 0.
Returns:
this configuration object

addSubConfiguration

public AbstractNodeBuilderConfiguration addSubConfiguration(UaNodeBuilderConfiguration config)
Add an additional "function". These are searched linearly before other configurations. Use this in case an instantiation rule cannot be mapped to individual NodeId or BrowsePath, e.g. some wildcard BrowsePath based configuration.

Overrides:
addSubConfiguration in class AbstractNodeBuilderConfiguration

setCallbackInstancePropertyStrategy

public NodeBuilderConfiguration setCallbackInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId,
                                                                    UaVariableCallback callback)

setCallbackInstancePropertyStrategy

public NodeBuilderConfiguration setCallbackInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId,
                                                                    UaVariableCallback callback)

setInstantiationStrategy

public NodeBuilderConfiguration setInstantiationStrategy(BrowsePath path,
                                                         InstantiationStrategy strategy)
Set an InstantiationStrategy for a given BrowsePath.


setInstantiationStrategy

public NodeBuilderConfiguration setInstantiationStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId,
                                                         InstantiationStrategy strategy)

setInstantiationStrategy

public NodeBuilderConfiguration setInstantiationStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId,
                                                         InstantiationStrategy strategy)

setPlainInstancePropertyStrategy

public NodeBuilderConfiguration setPlainInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationPropertyId)

setPlainInstancePropertyStrategy

public NodeBuilderConfiguration setPlainInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationPropertyId)

setReflectiveInstancePropertyStrategy

public NodeBuilderConfiguration setReflectiveInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationPropertyId)

setReflectiveInstancePropertyStrategy

public NodeBuilderConfiguration setReflectiveInstancePropertyStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationPropertyId)

setTwoStateVariableStrategy

public NodeBuilderConfiguration setTwoStateVariableStrategy(org.opcfoundation.ua.builtintypes.ExpandedNodeId instanceDeclarationId,
                                                            String trueState,
                                                            String falseState,
                                                            boolean defaultValue)

setTwoStateVariableStrategy

public NodeBuilderConfiguration setTwoStateVariableStrategy(org.opcfoundation.ua.builtintypes.NodeId instanceDeclarationId,
                                                            String trueState,
                                                            String falseState,
                                                            boolean defaultValue)

getInternalEntries

protected List<AbstractNodeBuilderConfiguration.InternalEntry> getInternalEntries(UaNodeBuilderConfiguration.InstantiationStrategySearchParameters parameters)
Specified by:
getInternalEntries in class AbstractNodeBuilderConfiguration


Copyright © 2018. All rights reserved.