org.elasticsearch.search.aggregations.bucket.range

Class InternalRange.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.bucket.range.InternalRange.Bucket

All Implemented Interfaces:

MultiBucketsAggregation.Bucket, Range.Bucket, HasAggregations

Direct Known Subclasses:

InternalDateRange.Bucket, InternalIPv4Range.Bucket

Enclosing class:

InternalRange<B extends InternalRange.Bucket>

public static class InternalRange.Bucket
extends Object
implements Range.Bucket

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
Bucket(String key, double from, double to, long docCount, InternalAggregations aggregations, ValueFormatter formatter)

Method Summary

Modifier and Type	Method and Description
protected String	generateKey(double from, double to, ValueFormatter formatter)
Aggregations	getAggregations()
long	getDocCount()
protected InternalRange.Factory<? extends InternalRange.Bucket,?>	getFactory()
Number	getFrom()
String	getFromAsString()
String	getKey()
Text	getKeyAsText()
Number	getTo()
String	getToAsString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket(String key,
              double from,
              double to,
              long docCount,
              InternalAggregations aggregations,
              @Nullable
              ValueFormatter formatter)

Method Detail

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)

getFrom

public Number getFrom()

Specified by:

getFrom in interface Range.Bucket

Returns:

The lower bound of the range

getTo

public Number getTo()

Specified by:

getTo in interface Range.Bucket

Returns:

The upper bound of the range (excluding)

getFromAsString

public String getFromAsString()

Specified by:

getFromAsString in interface Range.Bucket

Returns:

The string value for the lower bound of the range

getToAsString

public String getToAsString()

Specified by:

getToAsString in interface Range.Bucket

Returns:

The string value for the upper bound of the range (excluding)

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

getFactory

protected InternalRange.Factory<? extends InternalRange.Bucket,?> getFactory()

generateKey

protected String generateKey(double from,
                             double to,
                             @Nullable
                             ValueFormatter formatter)