Package org.opensearch.search.aggregations.bucket.histogram

Class RangeHistogramAggregator

java.lang.Object

org.opensearch.search.aggregations.BucketCollector

org.opensearch.search.aggregations.Aggregator

org.opensearch.search.aggregations.AggregatorBase

org.opensearch.search.aggregations.bucket.BucketsAggregator

org.opensearch.search.aggregations.bucket.histogram.AbstractHistogramAggregator

org.opensearch.search.aggregations.bucket.histogram.RangeHistogramAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.opensearch.common.lease.Releasable

public class RangeHistogramAggregator
extends AbstractHistogramAggregator

Aggregate all docs that match a given range

Opensearch.internal:

Nested Class Summary

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

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

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields inherited from class org.opensearch.search.aggregations.bucket.histogram.AbstractHistogramAggregator

bucketOrds, extendedBounds, formatter, hardBounds, interval, keyed, minDocCount, offset, order

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

docCountProvider

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
RangeHistogramAggregator(String name, AggregatorFactories factories, double interval, double offset, BucketOrder order, boolean keyed, long minDocCount, DoubleBounds extendedBounds, DoubleBounds hardBounds, ValuesSourceConfig valuesSourceConfig, SearchContext context, Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class org.opensearch.search.aggregations.bucket.histogram.AbstractHistogramAggregator

buildAggregations, buildEmptyAggregation, collectDebugInfo, doClose

Methods inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

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

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, scoreMode, subAggregator, subAggregators, toString

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

buildTopLevel, getPostCollectionAggregation, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Constructor Details

RangeHistogramAggregator

public RangeHistogramAggregator(String name,
 AggregatorFactories factories,
 double interval,
 double offset,
 BucketOrder order,
 boolean keyed,
 long minDocCount,
 DoubleBounds extendedBounds,
 DoubleBounds hardBounds,
 ValuesSourceConfig valuesSourceConfig,
 SearchContext context,
 Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                         throws IOException

Throws:

IOException

Method Details

getLeafCollector

protected LeafBucketCollector getLeafCollector(org.apache.lucene.index.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