org.elasticsearch.search.aggregations.bucket.histogram

Class InternalHistogram.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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

All Implemented Interfaces:

Streamable, ToXContent, Histogram.Bucket, MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

InternalHistogram<B extends InternalHistogram.Bucket>

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected ValueFormatter	formatter

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalHistogram.Bucket(boolean keyed, ValueFormatter formatter, InternalHistogram.Factory<?> factory)
InternalHistogram.Bucket(long key, long docCount, boolean keyed, ValueFormatter formatter, InternalHistogram.Factory factory, InternalAggregations aggregations)

Method Summary

Methods

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
protected InternalHistogram.Factory<?>	getFactory()
ValueFormatter	getFormatter()
Object	getKey()
String	getKeyAsString()
boolean	getKeyed()
void	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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.search.aggregations.bucket.MultiBucketsAggregation.Bucket

getProperty

Field Detail

formatter

protected final transient ValueFormatter formatter

Constructor Detail

InternalHistogram.Bucket

public InternalHistogram.Bucket(boolean keyed,
                        ValueFormatter formatter,
                        InternalHistogram.Factory<?> factory)

InternalHistogram.Bucket

public InternalHistogram.Bucket(long key,
                        long docCount,
                        boolean keyed,
                        ValueFormatter formatter,
                        InternalHistogram.Factory factory,
                        InternalAggregations aggregations)

Method Detail

getFactory

protected InternalHistogram.Factory<?> getFactory()

getKeyAsString

public String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

getKey

public Object getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

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 IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

getFormatter

public ValueFormatter getFormatter()

getKeyed

public boolean getKeyed()