Package com.arpnetworking.tsdcore.statistics

Class SumStatistic

java.lang.Object

com.arpnetworking.tsdcore.statistics.BaseStatistic

com.arpnetworking.tsdcore.statistics.SumStatistic

All Implemented Interfaces:

Statistic, Serializable

public final class SumStatistic
extends BaseStatistic

Takes the sum of the entries. Use StatisticFactory for construction.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot com)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SumStatistic.SumAccumulator	Accumulator computing the sum of values.

Method Summary

Modifier and Type	Method	Description
Quantity	calculate(List<Quantity> unorderedValues)	Compute the statistic from the List of Quantity instances.
Quantity	calculateAggregations(List<AggregatedData> aggregations)	Compute the statistic from the List of AggregatedData instances.
Calculator<Void>	createCalculator()	Create a Calculator for this statistic.
String	getName()	Accessor for the name of the statistic.

Methods inherited from class com.arpnetworking.tsdcore.statistics.BaseStatistic

equals, getAliases, getDependencies, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getName

public String getName()

Description copied from interface: Statistic

Accessor for the name of the statistic.

Returns:

The name of the statistic.

createCalculator

public Calculator<Void> createCalculator()

Description copied from interface: Statistic

Create a Calculator for this statistic.

Returns:

The new Calculator instance.

calculate

public Quantity calculate(List<Quantity> unorderedValues)

Description copied from interface: Statistic

Compute the statistic from the List of Quantity instances. By default the List of samples is not assumed to be in any particular order. However, any Statistic subclass may implement the marker interface OrderedStatistic indicating a requirement to be provided with samples that are sorted from smallest to largest. In all cases the samples are required to be unified into the same unit (or no unit).

Parameters:

unorderedValues - List of samples Quantity instances.

Returns:

Computed statistic Quantity instance.

calculateAggregations

public Quantity calculateAggregations(List<AggregatedData> aggregations)

Description copied from interface: Statistic

Compute the statistic from the List of AggregatedData instances. By default the List of samples is not assumed to be in any particular order. However, any Statistic subclass may implement the marker interface OrderedStatistic indicating a requirement to be provided with samples that are sorted from smallest to largest. In all cases the samples are required to be unified into the same unit (or no unit).

Parameters:

aggregations - Aggregations to combine.

Returns:

Computed statistic value.