stream.statistics

Class StatisticsLearner

java.lang.Object

stream.AbstractProcessor

stream.statistics.StatisticsLearner

All Implemented Interfaces:

Processor, Service, StatefulProcessor, StatisticsService

Direct Known Subclasses:

Maxima, Minima, Sum

public abstract class StatisticsLearner
extends AbstractProcessor
implements StatisticsService

Author:

chris

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	keys
protected String	prefix
protected Statistics	statistics

Fields inherited from class stream.AbstractProcessor

context

Constructor Summary

Constructors

Constructor and Description
StatisticsLearner()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getKeys()
String	getPrefix()
Statistics	getStatistics()
Data	process(Data data)
void	reset()
void	resetState()
void	setKeys(String[] keys)
void	setPrefix(String prefix)
abstract void	updateStatistics(Data item)

Methods inherited from class stream.AbstractProcessor

finish, init

Methods inherited from class java.lang.Object

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

Field Detail

keys

protected String[] keys

statistics

protected Statistics statistics

prefix

protected String prefix

Constructor Detail

StatisticsLearner

public StatisticsLearner()

Method Detail

getKeys

public String[] getKeys()

Returns:

the keys

setKeys

@Parameter(required=false,
           description="The keys/attributes this processor should account statistics (sum,average,min/max) for")
public void setKeys(String[] keys)

Parameters:

keys - the keys to set

getPrefix

public String getPrefix()

Returns:

the prefix

setPrefix

@Parameter(required=false,
           description="An optional prefix that is prepended to the attribute names, which prevents the original attribute values from being overwritten by the respective sum/average/min/max value")
public void setPrefix(String prefix)

Parameters:

prefix - the prefix to set

process

public Data process(Data data)

Specified by:

process in interface Processor

See Also:

DataProcessor

getStatistics

public Statistics getStatistics()

Specified by:

getStatistics in interface StatisticsService

See Also:

stream.statistics.StatisticsService#getStatistics(java.lang.String)

updateStatistics

public abstract void updateStatistics(Data item)

reset

public void reset()
           throws Exception

Specified by:

reset in interface Service

Throws:

Exception

See Also:

Service.reset()

resetState

public void resetState()
                throws Exception

Specified by:

resetState in interface StatefulProcessor

Overrides:

resetState in class AbstractProcessor

Throws:

Exception

See Also:

AbstractProcessor.resetState()