org.eclipse.scada.da.master.common

Class AbstractCommonHandlerImpl

java.lang.Object

org.eclipse.scada.da.master.AbstractMasterHandlerImpl

org.eclipse.scada.da.master.AbstractConfigurableMasterHandlerImpl

org.eclipse.scada.da.master.common.AbstractCommonHandlerImpl

All Implemented Interfaces:

MasterItemHandler

Direct Known Subclasses:

BlockHandlerImpl, ManualHandlerImpl, MarkerHandlerImpl, NegateHandlerImpl, RoundHandlerImpl, ScaleHandlerImpl

public abstract class AbstractCommonHandlerImpl
extends AbstractConfigurableMasterHandlerImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCommonHandlerImpl.AbstractConfiguration

Field Summary

Fields inherited from class org.eclipse.scada.da.master.AbstractMasterHandlerImpl

eventAttributes

Constructor Summary

Constructors

Constructor and Description
AbstractCommonHandlerImpl(String configurationId, ObjectPoolTracker<MasterItem> poolTracker, int priority, org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker, String prefix, String factoryId)

Method Summary

Modifier and Type	Method and Description
protected Event.EventBuilder	createEventBuilder() Create a pre-filled event builder
void	dataUpdate(Map<String,Object> context, DataItemValue.Builder builder) Called when data changed or the handler chain changed.
protected void	injectEventAttributes(Event.EventBuilder builder)
protected abstract void	processDataUpdate(Map<String,Object> context, DataItemValue.Builder builder)

Methods inherited from class org.eclipse.scada.da.master.AbstractConfigurableMasterHandlerImpl

getPrefixed, handleUpdate, processWrite, updateConfiguration, updateConfiguration

Methods inherited from class org.eclipse.scada.da.master.AbstractMasterHandlerImpl

addItem, createTrackers, dispose, getMasterItems, removeItem, reprocess, update

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommonHandlerImpl

public AbstractCommonHandlerImpl(String configurationId,
                                 ObjectPoolTracker<MasterItem> poolTracker,
                                 int priority,
                                 org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker,
                                 String prefix,
                                 String factoryId)

Method Detail

processDataUpdate

protected abstract void processDataUpdate(Map<String,Object> context,
                                          DataItemValue.Builder builder)
                                   throws Exception

Throws:

Exception

createEventBuilder

protected Event.EventBuilder createEventBuilder()

Create a pre-filled event builder

Returns:

a new event builder

injectEventAttributes

protected void injectEventAttributes(Event.EventBuilder builder)

dataUpdate

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

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

Specified by:

dataUpdate in class AbstractMasterHandlerImpl

Parameters:

context - the context object

builder - the changed value