Package org.elasticsearch.search.aggregations.bucket.range

Class RangeAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.range.RangeAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, Collector, Releasable

public class RangeAggregator
extends BucketsAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RangeAggregator.Range
static class	RangeAggregator.Unmapped<R extends RangeAggregator.Range>

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	KEYED_FIELD
static ParseField	RANGES_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
RangeAggregator(String name, AggregatorFactories factories, ValuesSource.Numeric valuesSource, DocValueFormat format, InternalRange.Factory rangeFactory, RangeAggregator.Range[] ranges, boolean keyed, SearchContext context, Aggregator parent, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Modifier and Type	Method	Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)	Build an aggregation for data that has been collected into bucket.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
LeafBucketCollector	getLeafCollector(LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.
ScoreMode	scoreMode()	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.bucket.BucketsAggregator

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectExistingBucket, consumeBucketsAndMaybeBreak, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, mergeBuckets

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doClose, 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

RANGES_FIELD

public static final ParseField RANGES_FIELD

KEYED_FIELD

public static final ParseField KEYED_FIELD

Constructor Detail

RangeAggregator

public RangeAggregator(String name,
                       AggregatorFactories factories,
                       ValuesSource.Numeric valuesSource,
                       DocValueFormat format,
                       InternalRange.Factory rangeFactory,
                       RangeAggregator.Range[] ranges,
                       boolean keyed,
                       SearchContext context,
                       Aggregator parent,
                       List<PipelineAggregator> pipelineAggregators,
                       Map<String,Object> metaData)
                throws IOException

Throws:

IOException

Method Detail

scoreMode

public ScoreMode scoreMode()

Description copied from class: AggregatorBase

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

Specified by:

scoreMode in interface Collector

Overrides:

scoreMode in class AggregatorBase

getLeafCollector

public LeafBucketCollector getLeafCollector(LeafReaderContext ctx,
                                            LeafBucketCollector sub)
                                     throws 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:

IOException

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)
                                     throws IOException

Description copied from class: Aggregator

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

Specified by:

buildAggregation in class Aggregator

Throws:

IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator