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

Class AttributeWriteHandlerItem

java.lang.Object

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

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

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

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

All Implemented Interfaces:

DataItem

public class AttributeWriteHandlerItem
extends DataItemInputChained

Field Summary

Fields inherited from class org.eclipse.scada.da.server.common.chain.DataItemInputChained

primaryValue, secondaryValue

Fields inherited from class org.eclipse.scada.da.server.common.chain.DataItemBaseChained

chain, executor, primaryAttributes, secondaryAttributes

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

listener

Constructor Summary

Constructors

Constructor and Description
AttributeWriteHandlerItem(DataItemInformation di, AttributeWriteHandler writeHandler, Executor executor)
AttributeWriteHandlerItem(String itemId, AttributeWriteHandler writeHandler, Executor executor)

Method Summary

Modifier and Type	Method and Description
protected WriteAttributeResults	handleUnhandledAttributes(WriteAttributeResults writeAttributeResults, Map<String,Variant> attributes) Handle all unhandled set attribute requests
protected WriteResult	processWriteValue(Variant value, OperationParameters operationParameters)
void	setWriteHandler(AttributeWriteHandler writeHandler) Change the write handler
NotifyFuture<WriteResult>	startWriteValue(Variant value, OperationParameters operationParameters) The write operation of a data item.

Methods inherited from class org.eclipse.scada.da.server.common.chain.DataItemInputChained

getCacheAttributes, getCacheValue, process, readValue, updateData

Methods inherited from class org.eclipse.scada.da.server.common.chain.DataItemBaseChained

addChainElement, addChainElement, getAttributes, getChainCopy, processSetAttributes, removeChainElement, setChain, startSetAttributes

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

getInformation, handleListenerChange, notifyData, notifyData, setListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeWriteHandlerItem

public AttributeWriteHandlerItem(DataItemInformation di,
                                 AttributeWriteHandler writeHandler,
                                 Executor executor)

AttributeWriteHandlerItem

public AttributeWriteHandlerItem(String itemId,
                                 AttributeWriteHandler writeHandler,
                                 Executor executor)

Method Detail

setWriteHandler

public void setWriteHandler(AttributeWriteHandler writeHandler)

Change the write handler

The write handler will not be called for the last written value only for the next one.

Parameters:

writeHandler - the new write handler

handleUnhandledAttributes

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

Description copied from class: DataItemBaseChained

Handle all unhandled set attribute requests

Overrides:

handleUnhandledAttributes in class DataItemBaseChained

Parameters:

writeAttributeResults - the result set

attributes - the attributes to set

Returns:

the final result

startWriteValue

public NotifyFuture<WriteResult> startWriteValue(Variant value,
                                                 OperationParameters operationParameters)

Description copied from interface: DataItem

The write operation of a data item.

Specified by:

startWriteValue in interface DataItem

Overrides:

startWriteValue in class DataItemInputChained

Parameters:

value - The value to write to the subsystem

Returns:

the future to the operation

processWriteValue

protected WriteResult processWriteValue(Variant value,
                                        OperationParameters operationParameters)