com.prosysopc.ua.pubsub

Class PubSubVariableDataSetConfFactory

java.lang.Object

com.prosysopc.ua.pubsub.PubSubVariableDataSetConfFactory

public class PubSubVariableDataSetConfFactory
extends Object

A Factory or a Template that produces PubSubVariableDataSetConf for "well known" (via the DataSetClassId) DataSets (or their templates, i.e. when the factory is used to produce the dataset, the node/value for a given field is given and everyhing else related to the field is effectively hard-coded in the template).

NOTE! At the moment this factory does not support setting AttributeId (Value assumed), DeadbandType, DeadbandValue, IndexRange nor SamplingIntervalHint for a node-based source.

Method Summary

Modifier and Type	Method and Description
PubSubVariableDataSetConf	build(String name) Returns a PublishedVariableDataSet with the given name with all fields set either to be constants or node-based, throws IllegalStateException if not all fields are set.
static PubSubVariableDataSetConfFactory	from(PubSubVariableDataSetConf partial) Constructs PubSubVariableDataSetConfFactory that reflects the given partial representation of a DataSet.
void	setFieldToConstant(String fieldName, Object value) Sets field value to a constant, effectively setting the PubSubPublishedVariableConf.getSubstituteValue() plus setting PubSubPublishedVariableConf#getForceSubstituteValue() to true.
void	setFieldToNode(String fieldName, UaNodeId node) Sets field value to be node-based, effectively setting PubSubPublishedVariableConf.getPublishedVariable().

Methods inherited from class java.lang.Object

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

Method Detail

from

public static PubSubVariableDataSetConfFactory from(PubSubVariableDataSetConf partial)

Constructs PubSubVariableDataSetConfFactory that reflects the given partial representation of a DataSet. Non-templating related fields are ignored, such as the name of the DataSet and the NodeId/SubstituteValues of fields. NOTE! The given DataSet shall contain a PubSubVariableDataSetConf.getDataSetClassId() and all fields shall have their DataType/ValueRank defined, otherwise this method will throw IllegalArgumentException.

build

public PubSubVariableDataSetConf build(String name)

Returns a PublishedVariableDataSet with the given name with all fields set either to be constants or node-based, throws IllegalStateException if not all fields are set.

setFieldToConstant

public void setFieldToConstant(String fieldName,
                               Object value)

Sets field value to a constant, effectively setting the PubSubPublishedVariableConf.getSubstituteValue() plus setting PubSubPublishedVariableConf#getForceSubstituteValue() to true. Removes any previous mapping (constant or node) for the field.

setFieldToNode

public void setFieldToNode(String fieldName,
                           UaNodeId node)

Sets field value to be node-based, effectively setting PubSubPublishedVariableConf.getPublishedVariable(). Removes any previous mapping (constant or node) for the field.