org.opennms.newts.api.query

Class ResultDescriptor

java.lang.Object

org.opennms.newts.api.query.ResultDescriptor

public class ResultDescriptor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResultDescriptor.BinaryFunction
static interface	ResultDescriptor.UnaryFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEARTBEAT_MULTIPLIER Multiple of the step size to use as default heartbeat.
static int	DEFAULT_STEP The default step size in milliseconds.
static double	DEFAULT_XFF Default X Files Factor (percentage of NaN pdps that are allowed when aggregating)

Constructor Summary

Constructors

Constructor and Description
ResultDescriptor() Constructs a new ResultDescriptor with the default step size.
ResultDescriptor(Duration step) Constructs a new ResultDescriptor with the given step size.
ResultDescriptor(long step) Constructs a new ResultDescriptor with the given step size.

Method Summary

Methods

Modifier and Type	Method and Description
ResultDescriptor	calculate(Calculation calculation)
ResultDescriptor	calculate(String label, CalculationFunction calculationFunction, String... args)
ResultDescriptor	calculate(String label, ResultDescriptor.BinaryFunction binaryFunction, String arg1, String arg2)
ResultDescriptor	calculate(String label, ResultDescriptor.UnaryFunction unaryFunction, String arg)
ResultDescriptor	datasource(String metricName, AggregationFunction aggregationFunction)
ResultDescriptor	datasource(String name, String metricName, AggregationFunction aggregationFunction)
ResultDescriptor	datasource(String name, String metricName, Duration heartbeat, AggregationFunction aggregationFunction)
ResultDescriptor	datasource(String name, String metricName, long heartbeat, AggregationFunction aggregationFunction)
ResultDescriptor	export(String... names)
ResultDescriptor	expression(String label, String expression)
Map<String,Calculation>	getCalculations()
Map<String,Datasource>	getDatasources()
Set<String>	getExports()
Duration	getInterval()
Set<String>	getLabels()
Set<String>	getSourceNames() Returns the set of unique source names; The names of the underlying samples used as the source of aggregations.
ResultDescriptor	step(Duration step)
ResultDescriptor	step(long step) Set the step duration.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STEP

public static final int DEFAULT_STEP

The default step size in milliseconds.

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_MULTIPLIER

public static final int DEFAULT_HEARTBEAT_MULTIPLIER

Multiple of the step size to use as default heartbeat.

See Also:

Constant Field Values

DEFAULT_XFF

public static final double DEFAULT_XFF

Default X Files Factor (percentage of NaN pdps that are allowed when aggregating)

See Also:

Constant Field Values

Constructor Detail

ResultDescriptor

public ResultDescriptor()

Constructs a new ResultDescriptor with the default step size.

ResultDescriptor

public ResultDescriptor(long step)

Constructs a new ResultDescriptor with the given step size.

Parameters:

step - duration in milliseconds

ResultDescriptor

public ResultDescriptor(Duration step)

Constructs a new ResultDescriptor with the given step size.

Parameters:

step - duration as an instance of Duration

Method Detail

getInterval

public Duration getInterval()

getDatasources

public Map<String,Datasource> getDatasources()

getCalculations

public Map<String,Calculation> getCalculations()

getSourceNames

public Set<String> getSourceNames()

Returns the set of unique source names; The names of the underlying samples used as the source of aggregations.

Returns:

source names

getLabels

public Set<String> getLabels()

getExports

public Set<String> getExports()

step

public ResultDescriptor step(long step)

Set the step duration.

Parameters:

step - duration in milliseconds

Returns:

step

public ResultDescriptor step(Duration step)

datasource

public ResultDescriptor datasource(String metricName,
                          AggregationFunction aggregationFunction)

datasource

public ResultDescriptor datasource(String name,
                          String metricName,
                          AggregationFunction aggregationFunction)

datasource

public ResultDescriptor datasource(String name,
                          String metricName,
                          long heartbeat,
                          AggregationFunction aggregationFunction)

datasource

public ResultDescriptor datasource(String name,
                          String metricName,
                          Duration heartbeat,
                          AggregationFunction aggregationFunction)

export

public ResultDescriptor export(String... names)

calculate

public ResultDescriptor calculate(Calculation calculation)

calculate

public ResultDescriptor calculate(String label,
                         CalculationFunction calculationFunction,
                         String... args)

calculate

public ResultDescriptor calculate(String label,
                         ResultDescriptor.BinaryFunction binaryFunction,
                         String arg1,
                         String arg2)

calculate

public ResultDescriptor calculate(String label,
                         ResultDescriptor.UnaryFunction unaryFunction,
                         String arg)

expression

public ResultDescriptor expression(String label,
                          String expression)

toString

public String toString()

Overrides:

toString in class Object