net.opentsdb.core

Class Aggregators

java.lang.Object

net.opentsdb.core.Aggregators

public final class Aggregators
extends Object

Utility class that provides common, generally useful aggregators.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Aggregators.Interpolation Different interpolation methods

Field Summary

Fields

Modifier and Type	Field and Description
static Aggregator	AVG Aggregator that returns the average value of the data point.
static Aggregator	DEV Aggregator that returns the Standard Deviation of the data points.
static Aggregator	MAX Aggregator that returns the maximum data point.
static Aggregator	MIMMAX Returns the maximum data point, causing SpanGroup to set .MinValue if timestamps don't line up instead of interpolating.
static Aggregator	MIMMIN Returns the minimum data point, causing SpanGroup to set .MaxValue if timestamps don't line up instead of interpolating.
static Aggregator	MIN Aggregator that returns the minimum data point.
static Aggregator	SUM Aggregator that sums up all the data points.
static Aggregator	ZIMSUM Sums data points but will cause the SpanGroup to return a 0 if timesamps don't line up instead of interpolating.

Method Summary

Methods

Modifier and Type	Method and Description
static Aggregator	get(String name) Returns the aggregator corresponding to the given name.
static Set<String>	set() Returns the set of the names that can be used with get.

Methods inherited from class java.lang.Object

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

Field Detail

SUM

public static final Aggregator SUM

Aggregator that sums up all the data points.

MIN

public static final Aggregator MIN

Aggregator that returns the minimum data point.

MAX

public static final Aggregator MAX

Aggregator that returns the maximum data point.

AVG

public static final Aggregator AVG

Aggregator that returns the average value of the data point.

DEV

public static final Aggregator DEV

Aggregator that returns the Standard Deviation of the data points.

ZIMSUM

public static final Aggregator ZIMSUM

Sums data points but will cause the SpanGroup to return a 0 if timesamps don't line up instead of interpolating.

MIMMIN

public static final Aggregator MIMMIN

Returns the minimum data point, causing SpanGroup to set .MaxValue if timestamps don't line up instead of interpolating.

MIMMAX

public static final Aggregator MIMMAX

Returns the maximum data point, causing SpanGroup to set .MinValue if timestamps don't line up instead of interpolating.

Method Detail

set

public static Set<String> set()

Returns the set of the names that can be used with get.

get

public static Aggregator get(String name)

Returns the aggregator corresponding to the given name.

Parameters:

name - The name of the aggregator to get.

Throws:

NoSuchElementException - if the given name doesn't exist.

See Also:

set()