org.eclipse.scada.da.server.common.chain

Class DataItemBaseChained

java.lang.Object

org.eclipse.scada.da.server.common.DataItemBase

org.eclipse.scada.da.server.common.chain.DataItemBaseChained

All Implemented Interfaces:

DataItem

Direct Known Subclasses:

DataItemInputChained, DataItemOutputChained

public abstract class DataItemBaseChained
extends DataItemBase

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<ChainProcessEntry>	chain The chain if items used for calculation
protected Executor	executor
protected Map<String,Variant>	primaryAttributes
protected AttributeManager	secondaryAttributes

Fields inherited from class org.eclipse.scada.da.server.common.DataItemBase

listener

Constructor Summary

Constructors

Constructor and Description
DataItemBaseChained(DataItemInformation dataItemInformation, Executor executor)

Method Summary

Modifier and Type	Method and Description
void	addChainElement(EnumSet<IODirection> when, ChainItem item)
void	addChainElement(IODirection when, ChainItem item)
Map<String,Variant>	getAttributes()
protected Collection<ChainProcessEntry>	getChainCopy()
protected WriteAttributeResults	handleUnhandledAttributes(WriteAttributeResults writeAttributeResults, Map<String,Variant> attributes) Handle all unhandled set attribute requests
protected abstract void	process()
protected WriteAttributeResults	processSetAttributes(Map<String,Variant> attributes, OperationParameters operationParameters)
void	removeChainElement(EnumSet<IODirection> when, ChainItem item)
void	setChain(Collection<ChainProcessEntry> chain) Replace the current chain with the new one
NotifyFuture<WriteAttributeResults>	startSetAttributes(Map<String,Variant> attributes, OperationParameters operationParameters) This method sets the attributes.

Methods inherited from class org.eclipse.scada.da.server.common.DataItemBase

getCacheAttributes, getCacheValue, getInformation, handleListenerChange, notifyData, notifyData, setListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scada.da.server.common.DataItem

readValue, startWriteValue

Field Detail

primaryAttributes

protected Map<String,Variant> primaryAttributes

secondaryAttributes

protected AttributeManager secondaryAttributes

chain

protected volatile Set<ChainProcessEntry> chain

The chain if items used for calculation

executor

protected final Executor executor

Constructor Detail

DataItemBaseChained

public DataItemBaseChained(DataItemInformation dataItemInformation,
                           Executor executor)

Method Detail

getAttributes

public Map<String,Variant> getAttributes()

startSetAttributes

public NotifyFuture<WriteAttributeResults> startSetAttributes(Map<String,Variant> attributes,
                                                              OperationParameters operationParameters)

This method sets the attributes.

It is intended to be overridden by subclasses that wish to handle attribute writes differently. The method needs to remove attributes from the parameter map that were handled and return a result for all attributes that were requested.

Parameters:

attributes - Attributes to set

Returns:

status for the attribute write request

processSetAttributes

protected WriteAttributeResults processSetAttributes(Map<String,Variant> attributes,
                                                     OperationParameters operationParameters)

handleUnhandledAttributes

protected WriteAttributeResults handleUnhandledAttributes(WriteAttributeResults writeAttributeResults,
                                                          Map<String,Variant> attributes)

Handle all unhandled set attribute requests

Parameters:

writeAttributeResults - the result set

attributes - the attributes to set

Returns:

the final result

process

protected abstract void process()

setChain

public void setChain(Collection<ChainProcessEntry> chain)

Replace the current chain with the new one

Parameters:

chain - the new chain

addChainElement

public void addChainElement(EnumSet<IODirection> when,
                            ChainItem item)

addChainElement

public void addChainElement(IODirection when,
                            ChainItem item)

removeChainElement

public void removeChainElement(EnumSet<IODirection> when,
                               ChainItem item)

getChainCopy

protected Collection<ChainProcessEntry> getChainCopy()