org.elasticsearch.search.aggregations.bucket.histogram

Class AbstractHistogramBuilder<AB extends AbstractHistogramBuilder<AB>>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB>

org.elasticsearch.search.aggregations.bucket.histogram.AbstractHistogramBuilder<AB>

All Implemented Interfaces:

NamedWriteable<AB>, StreamableReader<AB>, Writeable<AB>, ToXContent

Direct Known Subclasses:

DateHistogramAggregatorBuilder, HistogramAggregatorBuilder

public abstract class AbstractHistogramBuilder<AB extends AbstractHistogramBuilder<AB>>
extends ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB>

Nested Class Summary

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

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

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

Writeable.Reader<R>

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 ExtendedBounds	extendedBounds
protected long	interval
protected boolean	keyed
protected long	minDocCount
protected long	offset
protected org.elasticsearch.search.aggregations.bucket.histogram.InternalOrder	order

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

config

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

factoriesBuilder, metaData, name, type

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
protected abstract AB	createFactoryFromStream(java.lang.String name, StreamInput in)
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
protected XContentBuilder	doXContentInterval(XContentBuilder builder, ToXContent.Params params)
ExtendedBounds	extendedBounds()
AB	extendedBounds(ExtendedBounds extendedBounds)
java.lang.String	getWriteableName() Returns the name of the writeable object
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected AB	innerReadFrom(java.lang.String name, ValuesSourceType valuesSourceType, ValueType targetValueType, StreamInput in)
protected void	innerWriteTo(StreamOutput out)
long	interval()
AB	interval(long interval)
boolean	keyed()
AB	keyed(boolean keyed)
long	minDocCount()
AB	minDocCount(long minDocCount)
long	offset()
AB	offset(long offset)
Histogram.Order	order()
AB	order(Histogram.Order order)
protected void	writeFactoryToStream(StreamOutput out)

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

config, doBuild, doEquals, doHashCode, doReadFrom, doWriteTo, field, field, format, format, innerBuild, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, valueType, valueType

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

build, equals, getType, hashCode, readFrom, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

interval

protected long interval

offset

protected long offset

order

protected org.elasticsearch.search.aggregations.bucket.histogram.InternalOrder order

keyed

protected boolean keyed

minDocCount

protected long minDocCount

extendedBounds

protected ExtendedBounds extendedBounds

Method Detail

interval

public long interval()

interval

public AB interval(long interval)

offset

public long offset()

offset

public AB offset(long offset)

order

public Histogram.Order order()

order

public AB order(Histogram.Order order)

keyed

public boolean keyed()

keyed

public AB keyed(boolean keyed)

minDocCount

public long minDocCount()

minDocCount

public AB minDocCount(long minDocCount)

extendedBounds

public ExtendedBounds extendedBounds()

extendedBounds

public AB extendedBounds(ExtendedBounds extendedBounds)

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB extends AbstractHistogramBuilder<AB>>

Throws:

java.io.IOException

doXContentInterval

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

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<AB extends AbstractHistogramBuilder<AB>>

Overrides:

getWriteableName in class AggregatorBuilder<AB extends AbstractHistogramBuilder<AB>>

innerReadFrom

protected AB innerReadFrom(java.lang.String name,
                           ValuesSourceType valuesSourceType,
                           ValueType targetValueType,
                           StreamInput in)
                    throws java.io.IOException

Specified by:

innerReadFrom in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB extends AbstractHistogramBuilder<AB>>

Throws:

java.io.IOException

createFactoryFromStream

protected abstract AB createFactoryFromStream(java.lang.String name,
                                              StreamInput in)
                                       throws java.io.IOException

Throws:

java.io.IOException

innerWriteTo

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

Specified by:

innerWriteTo in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB extends AbstractHistogramBuilder<AB>>

Throws:

java.io.IOException

writeFactoryToStream

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

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB extends AbstractHistogramBuilder<AB>>

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB extends AbstractHistogramBuilder<AB>>