Package org.elasticsearch.search.aggregations.metrics.stats.extended

Class ExtendedStatsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.metrics.MetricsAggregator

org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator

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

org.elasticsearch.search.aggregations.metrics.stats.extended.ExtendedStatsAggregator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.search.Collector, Releasable

public class ExtendedStatsAggregator
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.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	SIGMA_FIELD

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
ExtendedStatsAggregator(java.lang.String name, ValuesSource.Numeric valuesSource, DocValueFormat formatter, SearchContext context, Aggregator parent, double sigma, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
InternalAggregation	buildAggregation(long bucket)	Build an aggregation for data that has been collected into bucket.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
void	doClose()	Release instance-specific data.
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.
boolean	hasMetric(java.lang.String name)
double	metric(java.lang.String name, long owningBucketOrd)
boolean	needsScores()	Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, close, context, doPostCollection, doPreCollection, getLeafCollector, metaData, name, parent, pipelineAggregators, postCollection, preCollection, preGetSubLeafCollectors, subAggregator, subAggregators, toString

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

descendsFromBucketAggregator

Methods inherited from class java.lang.Object

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

Field Detail

SIGMA_FIELD

public static final ParseField SIGMA_FIELD

Constructor Detail

ExtendedStatsAggregator

public ExtendedStatsAggregator(java.lang.String name,
                               ValuesSource.Numeric valuesSource,
                               DocValueFormat formatter,
                               SearchContext context,
                               Aggregator parent,
                               double sigma,
                               java.util.List<PipelineAggregator> pipelineAggregators,
                               java.util.Map<java.lang.String,java.lang.Object> metaData)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

needsScores

public boolean needsScores()

Description copied from class: AggregatorBase

Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

Specified by:

needsScores in interface org.apache.lucene.search.Collector

Overrides:

needsScores in class AggregatorBase

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
                                            LeafBucketCollector sub)
                                     throws java.io.IOException

Description copied from class: AggregatorBase

Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

Specified by:

getLeafCollector in class AggregatorBase

Throws:

java.io.IOException

hasMetric

public boolean hasMetric(java.lang.String name)

Specified by:

hasMetric in class NumericMetricsAggregator.MultiValue

metric

public double metric(java.lang.String name,
                     long owningBucketOrd)

Specified by:

metric in class NumericMetricsAggregator.MultiValue

buildAggregation

public InternalAggregation buildAggregation(long bucket)

Description copied from class: Aggregator

Build an aggregation for data that has been collected into bucket.

Specified by:

buildAggregation in class Aggregator

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase