Package org.epics.archiverappliance.retrieval.postprocessors

Class Statistics

java.lang.Object

org.epics.archiverappliance.retrieval.postprocessors.SummaryStatsPostProcessor

org.epics.archiverappliance.retrieval.postprocessors.Statistics

All Implemented Interfaces:

FillNoFillSupport, PostProcessor, PostProcessorWithConsolidatedEventStream

public class Statistics
extends SummaryStatsPostProcessor

Statistics is a post processor which provides a set of statistical numbers for a specific bin. The order of parameters is: mean, std, min, max, count.

Author:

Jaka Bobnar

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTITY

Fields inherited from class org.epics.archiverappliance.retrieval.postprocessors.SummaryStatsPostProcessor

consolidatedData

Constructor Summary

Constructors

Constructor	Description
Statistics()

Method Summary

Modifier and Type	Method	Description
SummaryStatsVectorCollector	getCollector()
int	getElementCount()
String	getIdentity()	The string used by clients to identify this post processor when making retrieval requests.
boolean	isProvidingVectorData()

Methods inherited from class org.epics.archiverappliance.retrieval.postprocessors.SummaryStatsPostProcessor

doNotInheritValuesFromPrevioisBins, estimateMemoryConsumption, getBinTimestamps, getBinTimestamps, getConsolidatedEventStream, getEndBinEpochSeconds, getExtension, getStartBinEpochSeconds, initialize, wrap, zeroOutEmptyBins

Methods inherited from class java.lang.Object

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

Field Details

IDENTITY

public static final String IDENTITY

See Also:

• Constant Field Values

Constructor Details

Statistics

public Statistics()

Method Details

getIdentity

public String getIdentity()

Description copied from interface: PostProcessor

The string used by clients to identify this post processor when making retrieval requests. For example to identify the FirstSamplePP postprocessor, users would add a pp=firstSample to the request for data. The situation is a little more complex; if a post processor has parameters then it needs to combine these into a string and offer that as an extension. The identity is just the starting part of this.

1. For example, pp=firstSample_600 asks the server to sparsify with an interval of 600 seconds.
2. identity is firstSample.
3. extension is firstSample_600.
4. User specifies firstSample_600.
5. ETL caches the data as firstSample_600 if asked to.

Specified by:

getIdentity in interface PostProcessor

Specified by:

getIdentity in class SummaryStatsPostProcessor

Returns:

identify  

getElementCount

public int getElementCount()

Overrides:

getElementCount in class SummaryStatsPostProcessor

Returns:

the number of elements per sample that this post processor provides

isProvidingVectorData

public boolean isProvidingVectorData()

Overrides:

isProvidingVectorData in class SummaryStatsPostProcessor

Returns:

true if this post processor is providing an array (list) of data, or false if a single value is provided

getCollector

public SummaryStatsVectorCollector getCollector()

Specified by:

getCollector in class SummaryStatsPostProcessor