org.eclipse.scada.da.master

Class AbstractMasterHandlerImpl

java.lang.Object

org.eclipse.scada.da.master.AbstractMasterHandlerImpl

All Implemented Interfaces:

MasterItemHandler

Direct Known Subclasses:

AbstractConfigurableMasterHandlerImpl, CommonSumHandler, GenericRemoteMonitor, MapperMasterHandler, MasterItemLogger

public abstract class AbstractMasterHandlerImpl
extends Object
implements MasterItemHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Variant>	eventAttributes

Constructor Summary

Constructors

Constructor and Description
AbstractMasterHandlerImpl(ObjectPoolTracker<MasterItem> poolTracker)
AbstractMasterHandlerImpl(ObjectPoolTracker<MasterItem> poolTracker, int defaultPriority)

Method Summary

Modifier and Type	Method and Description
protected void	addItem(MasterItem item)
protected void	createTrackers(String[] masterIds)
abstract void	dataUpdate(Map<String,Object> context, DataItemValue.Builder value) Called when data changed or the handler chain changed.
void	dispose()
protected Collection<MasterItem>	getMasterItems() Get an unmodifiable list of master items
WriteRequestResult	processWrite(WriteRequest request) Process the write request
protected boolean	removeItem(MasterItem item)
protected void	reprocess()
void	update(UserInformation userInformation, Map<String,String> parameters)

Methods inherited from class java.lang.Object

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

Field Detail

eventAttributes

protected Map<String,Variant> eventAttributes

Constructor Detail

AbstractMasterHandlerImpl

public AbstractMasterHandlerImpl(ObjectPoolTracker<MasterItem> poolTracker)

AbstractMasterHandlerImpl

public AbstractMasterHandlerImpl(ObjectPoolTracker<MasterItem> poolTracker,
                                 int defaultPriority)

Method Detail

dispose

public void dispose()

update

public void update(UserInformation userInformation,
                   Map<String,String> parameters)
            throws Exception

Throws:

Exception

createTrackers

protected void createTrackers(String[] masterIds)

removeItem

protected boolean removeItem(MasterItem item)

addItem

protected void addItem(MasterItem item)

getMasterItems

protected Collection<MasterItem> getMasterItems()

Get an unmodifiable list of master items

Returns:

unmodifiable list of master items

reprocess

protected void reprocess()

dataUpdate

public abstract void dataUpdate(Map<String,Object> context,
                                DataItemValue.Builder value)

Description copied from interface: MasterItemHandler

Called when data changed or the handler chain changed.

The call gets a context object provided which each handler can use to store context information of one calculation run. Each calculation run gets a fresh new context. The context is intended to pass data from one handler to the next.

Although the value parameter is a mutable type, the handler may only make changes inside the dataUpdate method.

Specified by:

dataUpdate in interface MasterItemHandler

Parameters:

context - the context object

value - the changed value

processWrite

public WriteRequestResult processWrite(WriteRequest request)

Process the write request

This implementation does nothing and can be overridden by derived implementations.

Specified by:

processWrite in interface MasterItemHandler

Parameters:

request - the write request to handle

Returns:

the resulting write request