org.elasticsearch.search.aggregations.bucket.histogram

Class InternalHistogram

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Aggregation, Histogram, HistogramFactory, MultiBucketsAggregation

public final class InternalHistogram
extends InternalMultiBucketAggregation<InternalHistogram,InternalHistogram.Bucket>
implements Histogram, HistogramFactory

Implementation of 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.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

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

InternalAggregation.ReduceContext

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

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 class org.elasticsearch.search.aggregations.InternalAggregation

metaData, name

Fields inherited from interface org.elasticsearch.search.aggregations.bucket.histogram.Histogram

EXTENDED_BOUNDS_FIELD, INTERVAL_FIELD, KEYED_FIELD, MIN_DOC_COUNT_FIELD, OFFSET_FIELD, ORDER_FIELD

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalHistogram(StreamInput in) Stream from a stream.

Method Summary

Modifier and Type	Method and Description
InternalHistogram	create(java.util.List<InternalHistogram.Bucket> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalAggregation	createAggregation(java.util.List<MultiBucketsAggregation.Bucket> buckets) Create an InternalAggregation object that wraps the given buckets.
InternalHistogram.Bucket	createBucket(InternalAggregations aggregations, InternalHistogram.Bucket prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
InternalHistogram.Bucket	createBucket(java.lang.Number key, long docCount, InternalAggregations aggregations) Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.
protected boolean	doEquals(java.lang.Object obj) Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
protected int	doHashCode() Opportunity for subclasses to the InternalAggregation.hashCode() for this class.
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<InternalHistogram.Bucket>	getBuckets()
java.lang.Number	getKey(MultiBucketsAggregation.Bucket bucket) Get the key for the given bucket.
java.lang.String	getWriteableName() Returns the name of the writeable object
java.lang.Number	nextKey(java.lang.Number key) Given a key returned by HistogramFactory.getKey(org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket), compute the lowest key that is greater than it.

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

getProperty

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

equals, getMetaData, getName, getProperty, getType, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getType

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

isFragment

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

toXContent

Constructor Detail

InternalHistogram

public InternalHistogram(StreamInput in)
                  throws java.io.IOException

Stream from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getBuckets

public java.util.List<InternalHistogram.Bucket> getBuckets()

Specified by:

getBuckets in interface Histogram

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalHistogram,InternalHistogram.Bucket>

Returns:

The buckets of this aggregation.

create

public InternalHistogram create(java.util.List<InternalHistogram.Bucket> 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,InternalHistogram.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public InternalHistogram.Bucket createBucket(InternalAggregations aggregations,
                                             InternalHistogram.Bucket 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,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

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

getKey

public java.lang.Number getKey(MultiBucketsAggregation.Bucket bucket)

Description copied from interface: HistogramFactory

Get the key for the given bucket. Date histograms must return the number of millis since Epoch of the bucket key while numeric histograms must return the double value of the key.

Specified by:

getKey in interface HistogramFactory

nextKey

public java.lang.Number nextKey(java.lang.Number key)

Description copied from interface: HistogramFactory

Given a key returned by HistogramFactory.getKey(org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket), compute the lowest key that is greater than it.

Specified by:

nextKey in interface HistogramFactory

createAggregation

public InternalAggregation createAggregation(java.util.List<MultiBucketsAggregation.Bucket> buckets)

Description copied from interface: HistogramFactory

Create an InternalAggregation object that wraps the given buckets.

Specified by:

createAggregation in interface HistogramFactory

createBucket

public InternalHistogram.Bucket createBucket(java.lang.Number key,
                                             long docCount,
                                             InternalAggregations aggregations)

Description copied from interface: HistogramFactory

Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.

Specified by:

createBucket in interface HistogramFactory

doEquals

protected boolean doEquals(java.lang.Object obj)

Description copied from class: InternalAggregation

Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class. This method can safely cast obj to the subclass since the InternalAggregation.equals(Object) method checks that obj is the same class as this

Specified by:

doEquals in class InternalAggregation

doHashCode

protected int doHashCode()

Description copied from class: InternalAggregation

Opportunity for subclasses to the InternalAggregation.hashCode() for this class.

Specified by:

doHashCode in class InternalAggregation