Module org.elasticsearch.server

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

Interface HistogramFactory

All Known Implementing Classes:

InternalDateHistogram, InternalHistogram, InternalVariableWidthHistogram

public interface HistogramFactory

Implemented by histogram aggregations and used by pipeline aggregations to insert buckets.

Method Summary

Modifier and Type	Method	Description
InternalAggregation	createAggregation(List<MultiBucketsAggregation.Bucket> buckets)	Create an InternalAggregation object that wraps the given buckets.
MultiBucketsAggregation.Bucket	createBucket(Number key, long docCount, InternalAggregations aggregations)	Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.
Number	getKey(MultiBucketsAggregation.Bucket bucket)	Get the key for the given bucket.

Method Details

getKey

Number getKey(MultiBucketsAggregation.Bucket bucket)

Get the key for the given bucket. Date histograms must return the number of millis since Epoch of the bucket key while numeric histograms must return the double value of the key.

createAggregation

InternalAggregation createAggregation(List<MultiBucketsAggregation.Bucket> buckets)

Create an InternalAggregation object that wraps the given buckets.

createBucket

MultiBucketsAggregation.Bucket createBucket(Number key,
 long docCount,
 InternalAggregations aggregations)

Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.