Package org.elasticsearch.search.aggregations.bucket.histogram

Class HistogramAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.histogram.HistogramAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class HistogramAggregationBuilder
extends ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

A builder for histograms on numeric fields. This builder can operate on either base numeric fields, or numeric range fields. IP range fields are unsupported, and will throw at the factory layer.

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME
static org.elasticsearch.common.xcontent.ObjectParser<HistogramAggregationBuilder,String>	PARSER
static ValuesSourceRegistry.RegistryKey<HistogramAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	HistogramAggregationBuilder(String name)	Create a new builder with the given name.
	HistogramAggregationBuilder(StreamInput in)	Read from a stream, for internal use only.
protected	HistogramAggregationBuilder(HistogramAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected org.elasticsearch.common.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
protected DoubleBounds	extendedBounds()
HistogramAggregationBuilder	extendedBounds(double minBound, double maxBound)	Set extended bounds on this builder: buckets between minBound and maxBound will be created even if no documents fell into these buckets.
HistogramAggregationBuilder	extendedBounds(DoubleBounds extendedBounds)	Set extended bounds on this builder: buckets between minBound and maxBound will be created even if no documents fell into these buckets.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
HistogramAggregationBuilder	hardBounds(DoubleBounds hardBounds)	Set hard bounds on this histogram, specifying boundaries outside which buckets cannot be created.
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
double	interval()	Get the current interval that is set on this builder.
HistogramAggregationBuilder	interval(double interval)	Set the interval on this builder, and return the builder so that calls can be chained.
boolean	keyed()	Return whether buckets should be returned as a hash.
HistogramAggregationBuilder	keyed(boolean keyed)	Set whether to return buckets as a hash or as an array, and return the builder so that calls can be chained.
double	maxBound()	Get the current maximum bound that is set on this builder.
double	minBound()	Get the current minimum bound that is set on this builder.
long	minDocCount()	Return the minimum count of documents that buckets need to have in order to be included in the response.
HistogramAggregationBuilder	minDocCount(long minDocCount)	Set the minimum count of matching documents that buckets need to have and return this builder so that calls can be chained.
double	offset()	Get the current offset that is set on this builder.
HistogramAggregationBuilder	offset(double offset)	Set the offset on this builder, and return the builder so that calls can be chained.
BucketOrder	order()	Return the order to use to sort buckets of this histogram.
HistogramAggregationBuilder	order(List<BucketOrder> orders)	Sets the order in which the buckets will be returned.
HistogramAggregationBuilder	order(BucketOrder order)	Set a new order on this builder and return the builder so that calls can be chained.
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

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

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<HistogramAggregatorSupplier> REGISTRY_KEY

PARSER

public static final org.elasticsearch.common.xcontent.ObjectParser<HistogramAggregationBuilder,String> PARSER

Constructor Details

HistogramAggregationBuilder

public HistogramAggregationBuilder(String name)

Create a new builder with the given name.

HistogramAggregationBuilder

protected HistogramAggregationBuilder(HistogramAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

HistogramAggregationBuilder

public HistogramAggregationBuilder(StreamInput in)
                            throws IOException

Read from a stream, for internal use only.

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

Throws:

IOException

interval

public double interval()

Get the current interval that is set on this builder.

interval

public HistogramAggregationBuilder interval(double interval)

Set the interval on this builder, and return the builder so that calls can be chained.

offset

public double offset()

Get the current offset that is set on this builder.

offset

public HistogramAggregationBuilder offset(double offset)

Set the offset on this builder, and return the builder so that calls can be chained.

minBound

public double minBound()

Get the current minimum bound that is set on this builder.

maxBound

public double maxBound()

Get the current maximum bound that is set on this builder.

extendedBounds

protected DoubleBounds extendedBounds()

extendedBounds

public HistogramAggregationBuilder extendedBounds(double minBound,
 double maxBound)

Set extended bounds on this builder: buckets between minBound and maxBound will be created even if no documents fell into these buckets.

Throws:

IllegalArgumentException - if maxBound is less that minBound, or if either of the bounds are not finite.

extendedBounds

public HistogramAggregationBuilder extendedBounds(DoubleBounds extendedBounds)

Set extended bounds on this builder: buckets between minBound and maxBound will be created even if no documents fell into these buckets.

Throws:

IllegalArgumentException - if maxBound is less that minBound, or if either of the bounds are not finite.

hardBounds

public HistogramAggregationBuilder hardBounds(DoubleBounds hardBounds)

Set hard bounds on this histogram, specifying boundaries outside which buckets cannot be created.

order

public BucketOrder order()

Return the order to use to sort buckets of this histogram.

order

public HistogramAggregationBuilder order(BucketOrder order)

Set a new order on this builder and return the builder so that calls can be chained. A tie-breaker may be added to avoid non-deterministic ordering.

order

public HistogramAggregationBuilder order(List<BucketOrder> orders)

Sets the order in which the buckets will be returned. A tie-breaker may be added to avoid non-deterministic ordering.

keyed

public boolean keyed()

Return whether buckets should be returned as a hash. In case keyed is false, buckets will be returned as an array.

keyed

public HistogramAggregationBuilder keyed(boolean keyed)

Set whether to return buckets as a hash or as an array, and return the builder so that calls can be chained.

minDocCount

public long minDocCount()

Return the minimum count of documents that buckets need to have in order to be included in the response.

minDocCount

public HistogramAggregationBuilder minDocCount(long minDocCount)

Set the minimum count of matching documents that buckets need to have and return this builder so that calls can be chained.

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doXContentBody

protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                    throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

Throws:

IOException

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<HistogramAggregationBuilder>