org.elasticsearch.search.aggregations.metrics.percentiles

Class AbstractPercentilesAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.metrics.MetricsAggregator

org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator

org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator.MultiValue

org.elasticsearch.search.aggregations.metrics.percentiles.AbstractPercentilesAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

PercentileRanksAggregator, PercentilesAggregator

public abstract class AbstractPercentilesAggregator
extends NumericMetricsAggregator.MultiValue

Nested Class Summary

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

NumericMetricsAggregator.MultiValue, NumericMetricsAggregator.SingleValue

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

Aggregator.BucketAggregationMode, Aggregator.Parser, Aggregator.SubAggCollectionMode

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

BucketCollector.BucketAnalysisCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected double	compression
protected ValueFormatter	formatter
protected boolean	keyed
protected double[]	keys
protected ObjectArray<TDigestState>	states
protected ValuesSource.Numeric	valuesSource

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

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractPercentilesAggregator(String name, long estimatedBucketsCount, ValuesSource.Numeric valuesSource, AggregationContext context, Aggregator parent, double[] keys, double compression, boolean keyed, ValueFormatter formatter)

Method Summary

Modifier and Type	Method and Description
void	collect(int doc, long bucketOrd) Called during the query phase, to collect & aggregate the given document.
protected void	doClose() Release instance-specific data.
protected TDigestState	getState(long bucketOrd)
boolean	hasMetric(String name)
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)
boolean	shouldCollect()

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

metric

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

bucketAggregationMode, buildAggregation, buildEmptyAggregation, buildEmptySubAggregations, close, context, depth, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, shouldDefer, subAggregator, subAggregators

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

wrap

Methods inherited from class java.lang.Object

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

Field Detail

keys

protected final double[] keys

valuesSource

protected final ValuesSource.Numeric valuesSource

states

protected ObjectArray<TDigestState> states

compression

protected final double compression

keyed

protected final boolean keyed

formatter

protected ValueFormatter formatter

Constructor Detail

AbstractPercentilesAggregator

public AbstractPercentilesAggregator(String name,
                                     long estimatedBucketsCount,
                                     ValuesSource.Numeric valuesSource,
                                     AggregationContext context,
                                     Aggregator parent,
                                     double[] keys,
                                     double compression,
                                     boolean keyed,
                                     @Nullable
                                     ValueFormatter formatter)

Method Detail

shouldCollect

public boolean shouldCollect()

Specified by:

shouldCollect in class Aggregator

Returns:

Whether this aggregator is in the state where it can collect documents. Some aggregators can do their aggregations without actually collecting documents, for example, an aggregator that computes stats over unmapped fields doesn't need to collect anything as it knows to just return "empty" stats as the aggregation result.

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

collect

public void collect(int doc,
                    long bucketOrd)
             throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

bucketOrd - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

hasMetric

public boolean hasMetric(String name)

Specified by:

hasMetric in class NumericMetricsAggregator.MultiValue

getState

protected TDigestState getState(long bucketOrd)

doClose

protected void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class Aggregator