org.elasticsearch.search.aggregations.bucket.composite

Class HistogramValuesSourceBuilder

java.lang.Object

org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

org.elasticsearch.search.aggregations.bucket.composite.HistogramValuesSourceBuilder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class HistogramValuesSourceBuilder
extends CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

A CompositeValuesSourceBuilder that that builds a HistogramValuesSource from another numeric values source using the provided interval.

Nested Class Summary

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

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

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.bucket.composite.CompositeValuesSourceBuilder

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HistogramValuesSourceBuilder(StreamInput in)
	HistogramValuesSourceBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected void	doXContentBody(XContentBuilder builder, ToXContent.Params params)
protected org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig	innerBuild(SearchContext context, ValuesSourceConfig<?> config, int pos, int numPos, org.apache.lucene.search.SortField sortField) Creates a CompositeValuesSourceConfig for this source.
protected boolean	innerEquals(HistogramValuesSourceBuilder other)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out)
double	interval() Returns the interval that is set on this source
HistogramValuesSourceBuilder	interval(double interval) Sets the interval on this source.
java.lang.String	type()

Methods inherited from class org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

build, checkCanEarlyTerminate, equals, field, field, hashCode, missing, missing, name, order, order, order, script, script, toXContent, valueType, valueType, writeTo

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

HistogramValuesSourceBuilder

public HistogramValuesSourceBuilder(java.lang.String name)

HistogramValuesSourceBuilder

protected HistogramValuesSourceBuilder(StreamInput in)
                                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

innerWriteTo

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

Specified by:

innerWriteTo in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

innerEquals

protected boolean innerEquals(HistogramValuesSourceBuilder other)

Specified by:

innerEquals in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

type

public java.lang.String type()

interval

public double interval()

Returns the interval that is set on this source

interval

public HistogramValuesSourceBuilder interval(double interval)

Sets the interval on this source.

innerBuild

protected org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig innerBuild(SearchContext context,
                                                                                                        ValuesSourceConfig<?> config,
                                                                                                        int pos,
                                                                                                        int numPos,
                                                                                                        org.apache.lucene.search.SortField sortField)
                                                                                                 throws java.io.IOException

Description copied from class: CompositeValuesSourceBuilder

Creates a CompositeValuesSourceConfig for this source.

Specified by:

innerBuild in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Parameters:

context - The search context for this source.

config - The ValuesSourceConfig for this source.

pos - The position of this source in the composite key.

numPos - The total number of positions in the composite key.

sortField - The SortField of the index sort at this position or null if not present.

Throws:

java.io.IOException