Package org.opensearch.search.aggregations.support

Class ValuesSource.Range

java.lang.Object

org.opensearch.search.aggregations.support.ValuesSource

org.opensearch.search.aggregations.support.ValuesSource.Range

Enclosing class:

ValuesSource

public static class ValuesSource.Range
extends ValuesSource

Range type

Opensearch.internal:

Nested Class Summary

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

ValuesSource.Bytes, ValuesSource.GeoPoint, ValuesSource.GeoShape, 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 the current ValuesSource.Bytes.WithScript.BytesValues.
DocValueBits	docsWithValue(org.apache.lucene.index.LeafReaderContext context)
RangeType	rangeType()
Function<Rounding,Rounding.Prepared>	roundingPreparer(org.apache.lucene.index.IndexReader reader)	Build a function prepares rounding values to be called many times.

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

hasGlobalOrdinals, 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 the current ValuesSource.Bytes.WithScript.BytesValues.

Specified by:

bytesValues in class ValuesSource

docsWithValue

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

Specified by:

docsWithValue in class ValuesSource

Throws:

IOException

roundingPreparer

public Function<Rounding,Rounding.Prepared> roundingPreparer(org.apache.lucene.index.IndexReader reader)
                                                      throws IOException

Description copied from class: ValuesSource

Build a function prepares rounding values to be called many times.

This returns a Function because auto date histogram will need to call it many times over the course of running the aggregation.

Specified by:

roundingPreparer in class ValuesSource

Throws:

IOException

rangeType

public RangeType rangeType()