org.kairosdb.client.builder

Class AggregatorFactory

java.lang.Object

org.kairosdb.client.builder.AggregatorFactory

public class AggregatorFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
AggregatorFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static SamplingAggregator	createAverageAggregator(int value, TimeUnit unit) Creates an aggregator that returns the average values for each time period as specified.
static SamplingAggregator	createCountAggregator(int value, TimeUnit unit) Creates an aggregator that returns the count of all values over each time period as specified.
static CustomAggregator	createCustomAggregator(String name, String json) Creates an aggregator with a custom json fragment.
static CustomAggregator	createDivAggregator(double divisor) Creates an aggregator that divides each value by the divisor.
static SamplingAggregator	createMaxAggregator(int value, TimeUnit unit) Creates an aggregator that returns the maximum values for each time period as specified.
static SamplingAggregator	createMinAggregator(int value, TimeUnit unit) Creates an aggregator that returns the minimum values for each time period as specified.
static RateAggregator	createRateAggregator(TimeUnit unit) Creates an aggregator that returns the rate of change between each pair of data points
static SamplingAggregator	createStandardDeviationAggregator(int value, TimeUnit unit) Creates an aggregator that returns the standard deviation values for each time period as specified.
static SamplingAggregator	createSumAggregator(int value, TimeUnit unit) Creates an aggregator that returns the sum of all values over each time period as specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatorFactory

public AggregatorFactory()

Method Detail

createMinAggregator

public static SamplingAggregator createMinAggregator(int value,
                                     TimeUnit unit)

Creates an aggregator that returns the minimum values for each time period as specified. For example, "5 minutes" would returns the minimum value for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

min aggregator

createMaxAggregator

public static SamplingAggregator createMaxAggregator(int value,
                                     TimeUnit unit)

Creates an aggregator that returns the maximum values for each time period as specified. For example, "5 minutes" would returns the maximum value for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

max aggregator

createAverageAggregator

public static SamplingAggregator createAverageAggregator(int value,
                                         TimeUnit unit)

Creates an aggregator that returns the average values for each time period as specified. For example, "5 minutes" would returns the average value for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

average aggregator

createStandardDeviationAggregator

public static SamplingAggregator createStandardDeviationAggregator(int value,
                                                   TimeUnit unit)

Creates an aggregator that returns the standard deviation values for each time period as specified. For example, "5 minutes" would returns the standard deviation for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

standard deviation aggregator

createSumAggregator

public static SamplingAggregator createSumAggregator(int value,
                                     TimeUnit unit)

Creates an aggregator that returns the sum of all values over each time period as specified. For example, "5 minutes" would returns the sum of data points for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

sum aggregator

createCountAggregator

public static SamplingAggregator createCountAggregator(int value,
                                       TimeUnit unit)

Creates an aggregator that returns the count of all values over each time period as specified. For example, "5 minutes" would returns the count of data points for each 5 minute period.

Parameters:

value - value for time period.

unit - unit of time

Returns:

count aggregator

createDivAggregator

public static CustomAggregator createDivAggregator(double divisor)

Creates an aggregator that divides each value by the divisor.

Parameters:

divisor - divisor.

Returns:

div aggregator

createCustomAggregator

public static CustomAggregator createCustomAggregator(String name,
                                      String json)

Creates an aggregator with a custom json fragment. This method is used for custom aggregators that have been added to KairosDB. This does not create an aggregator on the server. The name must match the custom aggregator on the server.

Example:

      Aggregator aggregator = AggregatorFactory.createCustomAggregator("histogram", "\"percentile\": 0.75");
 

This produces aggregator JSON that looks like this:

      "name":"histogram",
      "percentile": 0.75
 

Parameters:

name - name of the aggregator.

json - aggregator JSON fragment

Returns:

customer aggregator

createRateAggregator

public static RateAggregator createRateAggregator(TimeUnit unit)

Creates an aggregator that returns the rate of change between each pair of data points

Parameters:

unit - unit of time

Returns:

rate aggregator