Package org.elasticsearch.search.aggregations.bucket.histogram

Class AbstractHistogramAggregator

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.histogram.AbstractHistogramAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.elasticsearch.core.Releasable

Direct Known Subclasses:

NumericHistogramAggregator, RangeHistogramAggregator

public abstract class AbstractHistogramAggregator
extends BucketsAggregator

Base class for functionality shared between aggregators for this histogram aggregation.

Nested Class Summary

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

Modifier and Type	Field	Description
protected final LongKeyedBucketOrds	bucketOrds
protected final DoubleBounds	extendedBounds
protected final DocValueFormat	formatter
protected final DoubleBounds	hardBounds
protected final double	interval
protected final boolean	keyed
protected final long	minDocCount
protected final double	offset
protected final BucketOrder	order

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
AbstractHistogramAggregator(String name, AggregatorFactories factories, double interval, double offset, BucketOrder order, boolean keyed, long minDocCount, DoubleBounds extendedBounds, DoubleBounds hardBounds, DocValueFormat formatter, AggregationContext context, Aggregator parent, CardinalityUpperBound cardinalityUpperBound, Map<String,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.
void	collectDebugInfo(BiConsumer<String,Object> add)	Collect debug information to add to the profiling results.
void	doClose()	Release instance-specific data.

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, doPostCollection, doPreCollection, getLeafCollector, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, scoreMode, searcher, subAggregator, subAggregators, topLevelQuery, toString

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

buildTopLevel, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Field Details

formatter

protected final DocValueFormat formatter

interval

protected final double interval

offset

protected final double offset

order

protected final BucketOrder order

keyed

protected final boolean keyed

minDocCount

protected final long minDocCount

extendedBounds

protected final DoubleBounds extendedBounds

hardBounds

protected final DoubleBounds hardBounds

bucketOrds

protected final LongKeyedBucketOrds bucketOrds

Constructor Details

AbstractHistogramAggregator

public AbstractHistogramAggregator(String name,
 AggregatorFactories factories,
 double interval,
 double offset,
 BucketOrder order,
 boolean keyed,
 long minDocCount,
 DoubleBounds extendedBounds,
 DoubleBounds hardBounds,
 DocValueFormat formatter,
 AggregationContext context,
 Aggregator parent,
 CardinalityUpperBound cardinalityUpperBound,
 Map<String,Object> metadata)
                            throws IOException

Throws:

IOException

Method Details

buildAggregations

public InternalAggregation[] buildAggregations(long[] owningBucketOrds)
                                        throws 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:

IOException

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

collectDebugInfo

public void collectDebugInfo(BiConsumer<String,Object> add)

Description copied from class: Aggregator

Collect debug information to add to the profiling results. This will only be called if the aggregation is being profiled.

Well behaved implementations will always call the superclass implementation just in case it has something interesting. They will also only add objects which can be serialized with StreamOutput.writeGenericValue(Object) and XContentBuilder.value(Object). And they'll have an integration test.

Overrides:

collectDebugInfo in class Aggregator