org.elasticsearch.search.aggregations.bucket.histogram

Class InternalHistogram.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.bucket.histogram.InternalHistogram.Bucket

All Implemented Interfaces:

Histogram.Bucket, MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

InternalHistogram<B extends InternalHistogram.Bucket>

public static class InternalHistogram.Bucket
extends Object
implements Histogram.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

Field Summary

Fields

Modifier and Type	Field and Description
protected ValueFormatter	formatter

Constructor Summary

Constructors

Constructor and Description
Bucket(long key, long docCount, ValueFormatter formatter, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
protected org.elasticsearch.search.aggregations.bucket.histogram.InternalHistogram.Factory<?>	getFactory()
String	getKey()
Number	getKeyAsNumber()
Text	getKeyAsText()

Methods inherited from class java.lang.Object

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

Field Detail

formatter

@Nullable
protected final transient ValueFormatter formatter

Constructor Detail

Bucket

public Bucket(long key,
              long docCount,
              @Nullable
              ValueFormatter formatter,
              InternalAggregations aggregations)

Method Detail

getFactory

protected org.elasticsearch.search.aggregations.bucket.histogram.InternalHistogram.Factory<?> getFactory()

getKey

public String getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

getKeyAsText

public Text getKeyAsText()

Specified by:

getKeyAsText in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as text (ideal for further streaming this instance)

getKeyAsNumber

public Number getKeyAsNumber()

Specified by:

getKeyAsNumber in interface Histogram.Bucket

Returns:

The key associated with the bucket (all documents that fall in this bucket were rounded to this key)

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Specified by:

getAggregations in interface HasAggregations

Returns:

The sub-aggregations of this bucket