org.elasticsearch.search.aggregations.bucket.histogram

Class InternalHistogram<B extends InternalHistogram.Bucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.histogram.InternalHistogram<B>

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, Histogram, MultiBucketsAggregation

Direct Known Subclasses:

InternalDateHistogram

public class InternalHistogram<B extends InternalHistogram.Bucket>
extends InternalAggregation
implements Histogram

TODO should be renamed to InternalNumericHistogram (see comment on Histogram)?

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalHistogram.Bucket

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

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

Histogram.Order

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 List<B>	buckets

Fields inherited from class org.elasticsearch.search.aggregations.InternalAggregation

name

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
protected B	createBucket(long key, long docCount, InternalAggregations aggregations, ValueFormatter formatter)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
B	getBucketByKey(Number key) Returns a bucket by the key associated with it.
B	getBucketByKey(String key) Returns a bucket by the key associated with it.
List<B>	getBuckets()
protected org.elasticsearch.search.aggregations.bucket.histogram.InternalHistogram.Factory<B>	getFactory()
void	readFrom(StreamInput in)
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
static void	registerStream()
InternalAggregation.Type	type()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

getName, readSize, toXContent, writeSize

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.Aggregation

getName

Field Detail

buckets

protected List<B extends InternalHistogram.Bucket> buckets

Method Detail

registerStream

public static void registerStream()

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

getBuckets

public List<B> 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

public B 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

public B 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.

getFactory

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

reduce

public InternalAggregation reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

createBucket

protected B createBucket(long key,
                         long docCount,
                         InternalAggregations aggregations,
                         @Nullable
                         ValueFormatter formatter)

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

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                                      ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException