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

Class SummarizeChainItem

java.lang.Object

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

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

All Implemented Interfaces:

ChainItem

Direct Known Subclasses:

SumPatternAttributesChainItem

public abstract class SummarizeChainItem
extends BaseChainItemCommon

A chain item that sums up attribute entries that match a specific condition.

Author:

Jens Reimann <jens.reimann@th4-systems.com>

Constructor Summary

Constructors

Constructor and Description
SummarizeChainItem(String baseName)

Method Summary

Modifier and Type	Method and Description
protected Set<String>	getIgnoreItems()
protected abstract boolean	matches(Variant value, String attributeName, Variant attributeValue) The method that will check if the attribute entry matches the condition.
Variant	process(Variant value, Map<String,Variant> attributes) Process the chain item

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

setAttributes, setReservedAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

SummarizeChainItem

public SummarizeChainItem(String baseName)

Method Detail

matches

protected abstract boolean matches(Variant value,
                                   String attributeName,
                                   Variant attributeValue)

The method that will check if the attribute entry matches the condition.

Parameters:

value - The current item value

attributeName - The attribute name

attributeValue - The attribute value

Returns:

true if the entry should match, false otherwise

process

public Variant process(Variant value,
                       Map<String,Variant> attributes)

Description copied from interface: ChainItem

Process the chain item

Parameters:

value - the value to process or null if a output item changed only the attributes

attributes - The current primary attributes

Returns:

the new result or null if the chain item does not change the input value

getIgnoreItems

protected Set<String> getIgnoreItems()