Package org.elasticsearch.search.aggregations.metrics

Class InternalTDigestPercentileRanks

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue

org.elasticsearch.search.aggregations.metrics.InternalTDigestPercentileRanks

All Implemented Interfaces:

Iterable<Percentile>, NamedWriteable, Writeable, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, PercentileRanks, ToXContent, ToXContentFragment

public class InternalTDigestPercentileRanks
extends InternalNumericMetricsAggregation.MultiValue
implements PercentileRanks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalTDigestPercentileRanks.Iter

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregation

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final double[]	keys
static final String	NAME
protected final TDigestState	state

Fields inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

format

Fields inherited from class org.elasticsearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.search.aggregations.metrics.PercentileRanks

TYPE_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalTDigestPercentileRanks(String name, double[] cdfValues, TDigestState state, boolean keyed, DocValueFormat formatter, Map<String,Object> metadata)
InternalTDigestPercentileRanks(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected org.elasticsearch.search.aggregations.metrics.AbstractInternalTDigestPercentiles	createReduced(String name, double[] keys, TDigestState merged, boolean keyed, Map<String,Object> metadata)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
DocValueFormat	formatter()
long	getEstimatedMemoryFootprint()
double[]	getKeys()	Return the keys (percentiles) requested.
TDigestState	getState()	Return the internal TDigestState sketch for this metric.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
Iterator<Percentile>	iterator()
boolean	keyed()	Should the output be keyed.
double	percent(double value)	Return the percentile for the given value.
String	percentAsString(double value)	Return the percentile for the given value as a String.
static double	percentileRank(TDigestState state, double value)
org.elasticsearch.search.aggregations.metrics.AbstractInternalTDigestPercentiles	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
double	value(double key)
double	value(String name)	Return the result of 1 value by name
Iterable<String>	valueNames()	Return an iterable over all value names this multi value aggregation provides.

Methods inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue

getProperty, sortValue, valueAsString

Methods inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

mustReduceOnSingleInternalAgg, sortValue

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregation.MultiValue

value, valueNames

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

keys

protected final double[] keys

state

protected final TDigestState state

Constructor Details

InternalTDigestPercentileRanks

public InternalTDigestPercentileRanks(String name,
 double[] cdfValues,
 TDigestState state,
 boolean keyed,
 DocValueFormat formatter,
 Map<String,Object> metadata)

InternalTDigestPercentileRanks

public InternalTDigestPercentileRanks(StreamInput in)
                               throws IOException

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

iterator

public Iterator<Percentile> iterator()

Specified by:

iterator in interface Iterable<Percentile>

percent

public double percent(double value)

Description copied from interface: PercentileRanks

Return the percentile for the given value.

Specified by:

percent in interface PercentileRanks

percentAsString

public String percentAsString(double value)

Description copied from interface: PercentileRanks

Return the percentile for the given value as a String.

Specified by:

percentAsString in interface PercentileRanks

value

public double value(double key)

createReduced

protected org.elasticsearch.search.aggregations.metrics.AbstractInternalTDigestPercentiles createReduced(String name,
 double[] keys,
 TDigestState merged,
 boolean keyed,
 Map<String,Object> metadata)

percentileRank

public static double percentileRank(TDigestState state,
 double value)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

value

public double value(String name)

Description copied from interface: NumericMetricsAggregation.MultiValue

Return the result of 1 value by name

Specified by:

value in interface NumericMetricsAggregation.MultiValue

Specified by:

value in class InternalNumericMetricsAggregation.MultiValue

Parameters:

name - of the value

Returns:

the value

valueNames

public Iterable<String> valueNames()

Description copied from interface: NumericMetricsAggregation.MultiValue

Return an iterable over all value names this multi value aggregation provides. The iterable might be created on the fly, if you need to call this multiple times, please cache the result in a variable on caller side..

Returns:

iterable over all value names

formatter

public DocValueFormat formatter()

getEstimatedMemoryFootprint

public long getEstimatedMemoryFootprint()

getState

public TDigestState getState()

Return the internal TDigestState sketch for this metric.

getKeys

public double[] getKeys()

Return the keys (percentiles) requested.

keyed

public boolean keyed()

Should the output be keyed.

reduce

public org.elasticsearch.search.aggregations.metrics.AbstractInternalTDigestPercentiles reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
 ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalNumericMetricsAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalNumericMetricsAggregation