org.opennms.netmgt.api.sample

Class SampleProcessor

java.lang.Object

org.opennms.netmgt.api.sample.SampleProcessor

All Implemented Interfaces:

Iterator<Results.Row>

Direct Known Subclasses:

Lerp, Rate, RollUp

public abstract class SampleProcessor
extends Object
implements Iterator<Results.Row>

Constructor Summary

Constructors

Constructor and Description
SampleProcessor()

Method Summary

Modifier and Type	Method and Description
protected Results.Row	fillMissingSamples(Results.Row row) Add in NaN samples for any Metrics missing from this Results.Row
Collection<Metric>	getMetrics() Returns the metrics associated with the stream of samples.
SampleProcessor	getProducer()
Resource	getResource()
void	remove()
void	setProducer(SampleProcessor producer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Constructor Detail

SampleProcessor

public SampleProcessor()

Method Detail

setProducer

public void setProducer(SampleProcessor producer)

getProducer

public SampleProcessor getProducer()

getMetrics

public Collection<Metric> getMetrics()

Returns the metrics associated with the stream of samples.

Classes extending SampleProcessor should override this method when they are the entrance to the chain (the processor added with SampleProcessorBuilder.prepend(SampleProcessor)), or when they need to transform the set of metrics as part of their processing.

Returns:

the metrics associated with this sample stream.

getResource

public Resource getResource()

remove

public void remove()

Specified by:

remove in interface Iterator<Results.Row>

fillMissingSamples

protected Results.Row fillMissingSamples(Results.Row row)

Add in NaN samples for any Metrics missing from this Results.Row

Parameters:

row - the row to transform.

Returns:

the (same) row, with any missing samples added.