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

Class BinaryRangeAggregator

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.BinaryRangeAggregator

All Implemented Interfaces:

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

public final class BinaryRangeAggregator
extends BucketsAggregator

A range aggregator for values that are stored in SORTED_SET doc values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BinaryRangeAggregator.Range

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

BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator

docCountProvider

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

collectableSubAggregators, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
BinaryRangeAggregator(java.lang.String name, AggregatorFactories factories, ValuesSource valuesSource, DocValueFormat format, java.util.List<BinaryRangeAggregator.Range> ranges, boolean keyed, AggregationContext context, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Summary

Modifier and Type	Method	Description
InternalAggregation[]	buildAggregations(long[] owningBucketOrds)	Build the results of this aggregation.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
protected LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.
org.apache.lucene.search.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

bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, preGetSubLeafCollectors, prepareSubAggs, resolveSortPath, rewriteBuckets

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

addRequestCircuitBreakerBytes, bigArrays, buildEmptySubAggregations, doClose, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, searcher, subAggregator, subAggregators, topLevelQuery, toString

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

buildTopLevel, collectDebugInfo, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Constructor Details

BinaryRangeAggregator

public BinaryRangeAggregator(java.lang.String name,
AggregatorFactories factories,
ValuesSource valuesSource,
DocValueFormat format,
java.util.List<BinaryRangeAggregator.Range> ranges,
boolean keyed,
AggregationContext context,
Aggregator parent,
CardinalityUpperBound cardinality,
java.util.Map<java.lang.String,java.lang.Object> metadata)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Details

scoreMode

public org.apache.lucene.search.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 org.apache.lucene.search.Collector

Overrides:

scoreMode in class AggregatorBase

getLeafCollector

protected 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

buildAggregations

public InternalAggregation[] buildAggregations(long[] owningBucketOrds)
                                        throws java.io.IOException

Description copied from class: Aggregator

Build the results of this aggregation.

Specified by:

buildAggregations in class Aggregator

Parameters:

owningBucketOrds - the ordinals of the buckets that we want to collect from this aggregation

Returns:

the results for each ordinal, in the same order as the array of ordinals

Throws:

java.io.IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator