org.elasticsearch.search.aggregations.bucket.histogram

Interface DateHistogram

All Superinterfaces:

Aggregation, Histogram, MultiBucketsAggregation

All Known Implementing Classes:

InternalDateHistogram

public interface DateHistogram
extends Histogram

A date_histogram aggregation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DateHistogram.Bucket
static class	DateHistogram.Interval The interval the date histogram is based on.

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.histogram.Histogram

Histogram.Order

Method Summary

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

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

getName

Method Detail

getBuckets

List<? extends DateHistogram.Bucket> getBuckets()

Specified by:

getBuckets in interface Histogram

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

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

getBucketByKey

DateHistogram.Bucket getBucketByKey(String key)

Description copied from interface: Histogram

Returns a bucket by the key associated with it.

Specified by:

getBucketByKey in interface Histogram

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the bucket.

Returns:

The bucket that is associated with the given key.

getBucketByKey

DateHistogram.Bucket getBucketByKey(Number key)

Description copied from interface: Histogram

Returns a bucket by the key associated with it.

Specified by:

getBucketByKey in interface Histogram

Parameters:

key - The key of the bucket.

Returns:

The bucket that is associated with the given key.

getBucketByKey

DateHistogram.Bucket getBucketByKey(org.joda.time.DateTime key)