org.elasticsearch.search.aggregations.bucket.histogram

Class HistogramBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder<HistogramBuilder>

org.elasticsearch.search.aggregations.bucket.histogram.HistogramBuilder

All Implemented Interfaces:

ToXContent

public class HistogramBuilder
extends ValuesSourceAggregationBuilder<HistogramBuilder>

Builder for the Histogram aggregation.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
HistogramBuilder(String name) Constructs a new histogram aggregation builder.

Method Summary

Modifier and Type	Method and Description
protected XContentBuilder	doInternalXContent(XContentBuilder builder, ToXContent.Params params)
HistogramBuilder	extendedBounds(Long min, Long max) Set extended bounds for the histogram.
HistogramBuilder	interval(long interval) Sets the interval for the histogram.
HistogramBuilder	minDocCount(long minDocCount) Sets the minimum document count per bucket.
HistogramBuilder	order(Histogram.Order order) Sets the order by which the buckets will be returned.
HistogramBuilder	postOffset(long postOffset) Set the offset to apply after having computed buckets.
HistogramBuilder	preOffset(long preOffset) Set the offset to apply prior to computing buckets.

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

field, internalXContent, lang, param, params, script

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

subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramBuilder

public HistogramBuilder(String name)

Constructs a new histogram aggregation builder.

Parameters:

name - The name of the aggregation (will serve as the unique identifier for the aggregation result in the response)

Method Detail

interval

public HistogramBuilder interval(long interval)

Sets the interval for the histogram.

Parameters:

interval - The interval for the histogram

Returns:

This builder

order

public HistogramBuilder order(Histogram.Order order)

Sets the order by which the buckets will be returned.

Parameters:

order - The order by which the buckets will be returned

Returns:

This builder

minDocCount

public HistogramBuilder minDocCount(long minDocCount)

Sets the minimum document count per bucket. Buckets with less documents than this min value will not be returned.

Parameters:

minDocCount - The minimum document count per bucket

Returns:

This builder

extendedBounds

public HistogramBuilder extendedBounds(Long min,
                                       Long max)

Set extended bounds for the histogram. In case the lower value in the histogram would be greater than min or the upper value would be less than max, empty buckets will be generated.

preOffset

public HistogramBuilder preOffset(long preOffset)

Set the offset to apply prior to computing buckets.

postOffset

public HistogramBuilder postOffset(long postOffset)

Set the offset to apply after having computed buckets.

doInternalXContent

protected XContentBuilder doInternalXContent(XContentBuilder builder,
                                             ToXContent.Params params)
                                      throws IOException

Specified by:

doInternalXContent in class ValuesSourceAggregationBuilder<HistogramBuilder>

Throws:

IOException