Package com.illumon.iris.db.v2.by

Class ApproximatePercentile.PercentileDefinition

java.lang.Object

com.illumon.iris.db.v2.by.ApproximatePercentile.PercentileDefinition

Enclosing class:

ApproximatePercentile

public static class ApproximatePercentile.PercentileDefinition
extends Object

A builder class for an approximate percentile definition to be used with ApproximatePercentile.approximatePercentiles(com.illumon.iris.db.tables.Table, com.illumon.iris.db.v2.by.ApproximatePercentile.PercentileDefinition, com.illumon.iris.db.v2.select.SelectColumn...).

Constructor Summary

Constructors

Constructor	Description
PercentileDefinition(String inputColumn)	Create a builder with the current input column set to inputColumn.

Method Summary

Modifier and Type	Method	Description
ApproximatePercentile.PercentileDefinition	add(double percentile, String resultName)	Adds an output column.
ApproximatePercentile.PercentileDefinition	addCount(String resultName)	Adds an output column with the count of observed values.
ApproximatePercentile.PercentileDefinition	addMax(String resultName)	Adds an output column with the maximum observed value.
ApproximatePercentile.PercentileDefinition	addMin(String resultName)	Adds an output column with the minimum observed value.
ApproximatePercentile.PercentileDefinition	exposeDigest(String digestColumnName)	If true, the tDigest column is exposed using the given name
ApproximatePercentile.PercentileDefinition	nextColumn(String inputColumn)	Sets the name of the inputColumn
ApproximatePercentile.PercentileDefinition	setCompression(double compression)	Sets the t-digest compression parameter.

Methods inherited from class java.lang.Object

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

Constructor Details

PercentileDefinition

public PercentileDefinition(String inputColumn)

Create a builder with the current input column set to inputColumn.

Parameters:

inputColumn - the current input column

Method Details

add

public ApproximatePercentile.PercentileDefinition add(double percentile,
 String resultName)

Adds an output column. To set the inputColumn call nextColumn(String).

Parameters:

percentile - the percentile to calculate

resultName - the result name

Returns:

a (possibly new) PercentileDefinition

addMax

public ApproximatePercentile.PercentileDefinition addMax(String resultName)

Adds an output column with the maximum observed value.

To set the inputColumn call nextColumn(String).

Parameters:

resultName - the result name

Returns:

a (possibly new) PercentileDefinition

addMin

public ApproximatePercentile.PercentileDefinition addMin(String resultName)

Adds an output column with the minimum observed value.

To set the inputColumn call nextColumn(String).

Parameters:

resultName - the result name

Returns:

a (possibly new) PercentileDefinition

addCount

public ApproximatePercentile.PercentileDefinition addCount(String resultName)

Adds an output column with the count of observed values.

To set the inputColumn call nextColumn(String).

Parameters:

resultName - the result name

Returns:

a (possibly new) PercentileDefinition

nextColumn

public ApproximatePercentile.PercentileDefinition nextColumn(String inputColumn)

Sets the name of the inputColumn

Parameters:

inputColumn - the name of the input column that subsequent calls to add(double, java.lang.String) operate on.

Returns:

a (possibly new) PercentileDefinition

setCompression

public ApproximatePercentile.PercentileDefinition setCompression(double compression)

Sets the t-digest compression parameter.

Parameters:

compression - the t-digest compression factor.

Returns:

a (possibly new) PercentileDefinition

exposeDigest

public ApproximatePercentile.PercentileDefinition exposeDigest(String digestColumnName)

If true, the tDigest column is exposed using the given name

Parameters:

digestColumnName - the name of the t-digest column in the output

Returns:

a (possibly new) PercentileDefinition