org.elasticsearch.search.aggregations.bucket.histogram

Interface Histogram

All Superinterfaces:

Aggregation, MultiBucketsAggregation

All Known Subinterfaces:

DateHistogram

All Known Implementing Classes:

InternalDateHistogram, InternalHistogram

public interface Histogram
extends MultiBucketsAggregation

A histogram aggregation. Defines multiple buckets, each representing an interval in a histogram.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Histogram.Bucket A bucket in the histogram where documents fall in
static class	Histogram.Order A strategy defining the order in which the buckets in this histogram are ordered.

Method Summary

Modifier and Type	Method and Description
Histogram.Bucket	getBucketByKey(Number key) Returns a bucket by the key associated with it.
Histogram.Bucket	getBucketByKey(String key) Returns a bucket by the key associated with it.
List<? extends Histogram.Bucket>	getBuckets()

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getName

Method Detail

getBuckets

List<? extends Histogram.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this histogram (each bucket representing an interval in the histogram)

getBucketByKey

Histogram.Bucket getBucketByKey(String key)

Returns a bucket by the key associated with it.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the bucket.

Returns:

The bucket that is associated with the given key.

getBucketByKey

Histogram.Bucket getBucketByKey(Number key)

Returns a bucket by the key associated with it.

Parameters:

key - The key of the bucket.

Returns:

The bucket that is associated with the given key.