com.prosysopc.ua.pubsub

Class PubSubVariableDataSetConf.Builder

java.lang.Object

com.prosysopc.ua.pubsub.PubSubVariableDataSetConf.Builder

All Implemented Interfaces:

PubSubConf.Builder<PubSubVariableDataSetConf.Builder>, PubSubDataSetConf.Builder<PubSubVariableDataSetConf.Builder>, PubSubNamedConf.Builder<PubSubVariableDataSetConf.Builder>

Enclosing class:

PubSubVariableDataSetConf

public static final class PubSubVariableDataSetConf.Builder
extends Object

Builder for PubSubVariableDataSetConf.

Field Summary

Fields

Modifier and Type	Field and Description
protected UUID	dataSetClassId
protected LocalizedText	description
protected String	name
protected List<PubSubPublishedVariableConf>	publishedVariables

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
PubSubVariableDataSetConf.Builder	addPublishedVariables(PubSubPublishedVariableConf... confs) Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds all defined published variables to this DataSet.
PubSubVariableDataSetConf.Builder	addPublishedVariables(PubSubPublishedVariableConf publishedVariables) Adds the value as an element for PubSubVariableDataSetConf.getPublishedVariables().
PubSubVariableDataSetConf.Builder	addPublishedVariables(UaNodeId... ids) Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds all given nodes with their Value Attribute as published variables to this DataSet.
PubSubVariableDataSetConf.Builder	addPublishedVariables(UaNodeId id, String name) Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds the given node with the Value Attribute as a published variable to this DataSet.
PubSubVariableDataSetConf.Builder	addPublishedVariables(UaNodeId id, String name, LocalizedText description) Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds the given node with the Value Attribute as a published variable to this DataSet.
PubSubVariableDataSetConf	build() Returns an instance of PubSubVariableDataSetConf with the values given to this builder.
UUID	getDataSetClassId()
LocalizedText	getDescription()
String	getName()
List<PubSubPublishedVariableConf>	getPublishedVariables()
PubSubVariableDataSetConf.Builder	setDataSetClassId(UUID dataSetClassId) Set the value for PubSubVariableDataSetConf.getDataSetClassId().
PubSubVariableDataSetConf.Builder	setDescription(LocalizedText description) Set the value for PubSubVariableDataSetConf.getDescription().
PubSubVariableDataSetConf.Builder	setName(String name) Set the value for PubSubVariableDataSetConf.getName().
PubSubConfSpecification	specification() Returns the specification of this object.

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.pubsub.PubSubConf.Builder

get, get, set, set, setAll

Field Detail

name

protected String name

dataSetClassId

protected UUID dataSetClassId

description

protected LocalizedText description

publishedVariables

protected List<PubSubPublishedVariableConf> publishedVariables

Constructor Detail

Builder

protected Builder()

Method Detail

addPublishedVariables

public PubSubVariableDataSetConf.Builder addPublishedVariables(PubSubPublishedVariableConf... confs)

Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds all defined published variables to this DataSet.

addPublishedVariables

public PubSubVariableDataSetConf.Builder addPublishedVariables(UaNodeId... ids)

Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds all given nodes with their Value Attribute as published variables to this DataSet.

addPublishedVariables

public PubSubVariableDataSetConf.Builder addPublishedVariables(UaNodeId id,
                                                               String name)

Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds the given node with the Value Attribute as a published variable to this DataSet. Uses the given name as the name of the field when calculating the DataSetMetaData for this DataSet.

addPublishedVariables

public PubSubVariableDataSetConf.Builder addPublishedVariables(UaNodeId id,
                                                               String name,
                                                               LocalizedText description)

Convenience method to addPublishedVariables(PubSubPublishedVariableConf) that adds the given node with the Value Attribute as a published variable to this DataSet. Uses the given name as the name of the field and the given description when calculating the DataSetMetaData for this DataSet.

specification

public PubSubConfSpecification specification()

Description copied from interface: PubSubConf.Builder

Returns the specification of this object. Can be used to dynamically set the fields of the PubSubConf object.

Specified by:

specification in interface PubSubConf.Builder<PubSubVariableDataSetConf.Builder>

getName

public String getName()

getDataSetClassId

public UUID getDataSetClassId()

getDescription

public LocalizedText getDescription()

getPublishedVariables

public List<PubSubPublishedVariableConf> getPublishedVariables()

setName

public PubSubVariableDataSetConf.Builder setName(String name)

Set the value for PubSubVariableDataSetConf.getName(). Returns itself for method chaining.

Specified by:

setName in interface PubSubNamedConf.Builder<PubSubVariableDataSetConf.Builder>

setDataSetClassId

public PubSubVariableDataSetConf.Builder setDataSetClassId(UUID dataSetClassId)

Set the value for PubSubVariableDataSetConf.getDataSetClassId(). Returns itself for method chaining.

Specified by:

setDataSetClassId in interface PubSubDataSetConf.Builder<PubSubVariableDataSetConf.Builder>

setDescription

public PubSubVariableDataSetConf.Builder setDescription(LocalizedText description)

Set the value for PubSubVariableDataSetConf.getDescription(). Returns itself for method chaining.

Specified by:

setDescription in interface PubSubDataSetConf.Builder<PubSubVariableDataSetConf.Builder>

addPublishedVariables

public PubSubVariableDataSetConf.Builder addPublishedVariables(PubSubPublishedVariableConf publishedVariables)

Adds the value as an element for PubSubVariableDataSetConf.getPublishedVariables(). Returns itself for method chaining.

build

public PubSubVariableDataSetConf build()

Returns an instance of PubSubVariableDataSetConf with the values given to this builder.

Specified by:

build in interface PubSubConf.Builder<PubSubVariableDataSetConf.Builder>