org.elasticsearch.search.aggregations.bucket.range

Class InternalBinaryRange.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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

All Implemented Interfaces:

Writeable, ToXContent, MultiBucketsAggregation.Bucket, Range.Bucket, HasAggregations

Enclosing class:

InternalBinaryRange

public static class InternalBinaryRange.Bucket
extends InternalMultiBucketAggregation.InternalBucket
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>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Bucket(DocValueFormat format, boolean keyed, java.lang.String key, org.apache.lucene.util.BytesRef from, org.apache.lucene.util.BytesRef to, long docCount, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
java.lang.Object	getFrom()
java.lang.String	getFromAsString()
java.lang.Object	getKey()
java.lang.String	getKeyAsString()
java.lang.Object	getTo()
java.lang.String	getToAsString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment

Constructor Detail

Bucket

public Bucket(DocValueFormat format,
              boolean keyed,
              java.lang.String key,
              org.apache.lucene.util.BytesRef from,
              org.apache.lucene.util.BytesRef to,
              long docCount,
              InternalAggregations aggregations)

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getKey

public java.lang.Object getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public java.lang.String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

getFrom

public java.lang.Object getFrom()

Specified by:

getFrom in interface Range.Bucket

Returns:

The lower bound of the range

getFromAsString

public java.lang.String getFromAsString()

Specified by:

getFromAsString in interface Range.Bucket

Returns:

The string value for the lower bound of the range

getTo

public java.lang.Object getTo()

Specified by:

getTo in interface Range.Bucket

Returns:

The upper bound of the range (excluding)

getToAsString

public java.lang.String getToAsString()

Specified by:

getToAsString in interface Range.Bucket

Returns:

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