org.elasticsearch.search.aggregations.bucket.histogram

Class InternalHistogram<B extends InternalHistogram.Bucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<InternalHistogram<B>,B>

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

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, Histogram, MultiBucketsAggregation

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

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

InternalMultiBucketAggregation.InternalBucket

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 java.util.List<B>	buckets
protected InternalHistogram.Factory<B>	factory
static InternalHistogram.Factory<InternalHistogram.Bucket>	HISTOGRAM_FACTORY

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

metaData, name

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
InternalHistogram<B>	create(java.util.List<B> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
B	createBucket(InternalAggregations aggregations, B prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doReadFrom(StreamInput in)
InternalAggregation	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.util.List<B>	getBuckets()
InternalHistogram.Factory<B>	getFactory()
Rounding	getRounding()
static void	registerStream()
protected static <B extends InternalHistogram.Bucket> InternalHistogram.Factory<B>	resolveFactory(java.lang.String factoryType)
InternalAggregation.Type	type()

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

getProperty

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

getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, writeSize, writeTo

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

getMetaData, getName, getProperty

Field Detail

HISTOGRAM_FACTORY

public static final InternalHistogram.Factory<InternalHistogram.Bucket> HISTOGRAM_FACTORY

buckets

protected java.util.List<B extends InternalHistogram.Bucket> buckets

factory

protected InternalHistogram.Factory<B extends InternalHistogram.Bucket> factory

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 java.util.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)

getFactory

public InternalHistogram.Factory<B> getFactory()

getRounding

public Rounding getRounding()

create

public InternalHistogram<B> create(java.util.List<B> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<InternalHistogram<B extends InternalHistogram.Bucket>,B extends InternalHistogram.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public B createBucket(InternalAggregations aggregations,
                      B prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalHistogram<B extends InternalHistogram.Bucket>,B extends InternalHistogram.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

doReduce

public InternalAggregation doReduce(java.util.List<InternalAggregation> aggregations,
                                    InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws java.io.IOException

Specified by:

doReadFrom in class InternalAggregation

Throws:

java.io.IOException

resolveFactory

protected static <B extends InternalHistogram.Bucket> InternalHistogram.Factory<B> resolveFactory(java.lang.String factoryType)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException