Package org.elasticsearch.search.aggregations.support

Class ValuesSource.Range

java.lang.Object

org.elasticsearch.search.aggregations.support.ValuesSource

org.elasticsearch.search.aggregations.support.ValuesSource.Range

Enclosing class:

ValuesSource

public static class ValuesSource.Range
extends ValuesSource

ValuesSource for fields who's values are best thought of as ranges of numbers, dates, or IP addresses.

Nested Class Summary

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

ValuesSource.Bytes, ValuesSource.GeoPoint, ValuesSource.Numeric, ValuesSource.Range

Field Summary

Fields

Modifier and Type	Field	Description
protected final IndexFieldData<?>	indexFieldData

Constructor Summary

Constructors

Constructor	Description
Range(IndexFieldData<?> indexFieldData, RangeType rangeType)

Method Summary

Modifier and Type	Method	Description
SortedBinaryDocValues	bytesValues(org.apache.lucene.index.LeafReaderContext context)	Get a byte array like view into the values.
DocValueBits	docsWithValue(org.apache.lucene.index.LeafReaderContext context)	Get a "has any values" view into the values.
RangeType	rangeType()
Function<Rounding,Rounding.Prepared>	roundingPreparer()	Build a function to prepare Roundings.

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

hasOrdinals, needsScores

Methods inherited from class java.lang.Object

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

Field Details

indexFieldData

protected final IndexFieldData<?> indexFieldData

Constructor Details

Range

public Range(IndexFieldData<?> indexFieldData,
 RangeType rangeType)

Method Details

bytesValues

public SortedBinaryDocValues bytesValues(org.apache.lucene.index.LeafReaderContext context)

Description copied from class: ValuesSource

Get a byte array like view into the values. This is the "native" way to access ValuesSource.Bytes-style values.

Specified by:

bytesValues in class ValuesSource

docsWithValue

public DocValueBits docsWithValue(org.apache.lucene.index.LeafReaderContext context)
                           throws IOException

Description copied from class: ValuesSource

Get a "has any values" view into the values. It'll try to pick the "most native" way to check if there are any values, but it builds its own view into the values so if you need any of the actual values its best to use something like ValuesSource.bytesValues(org.apache.lucene.index.LeafReaderContext) or ValuesSource.Numeric.doubleValues(org.apache.lucene.index.LeafReaderContext) but if you just need to know if there are any values then use this.

Specified by:

docsWithValue in class ValuesSource

Throws:

IOException

roundingPreparer

public Function<Rounding,Rounding.Prepared> roundingPreparer()
                                                      throws IOException

Description copied from class: ValuesSource

Build a function to prepare Roundings.

This returns a Function because auto date histogram will need to call it many times over the course of running the aggregation. Other aggregations should feel free to call it once.

Specified by:

roundingPreparer in class ValuesSource

Throws:

IOException

rangeType

public RangeType rangeType()