Package org.opensearch.search.aggregations.support

Class ValuesSource.Numeric

java.lang.Object

org.opensearch.search.aggregations.support.ValuesSource

org.opensearch.search.aggregations.support.ValuesSource.Numeric

Direct Known Subclasses:

RoundingValuesSource, ValuesSource.Numeric.FieldData, ValuesSource.Numeric.Script, ValuesSource.Numeric.WithScript

Enclosing class:

ValuesSource

public abstract static class ValuesSource.Numeric
extends ValuesSource

Numeric values source type

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValuesSource.Numeric.FieldData	Field data for numerics
static class	ValuesSource.Numeric.Script	ValuesSource implementation for stand alone scripts returning a Numeric value
static class	ValuesSource.Numeric.WithScript	ValuesSource subclass for Numeric fields with a Value Script applied

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
static final ValuesSource.Numeric	EMPTY

Constructor Summary

Constructors

Constructor	Description
Numeric()

Method Summary

Modifier and Type	Method	Description
DocValueBits	docsWithValue(org.apache.lucene.index.LeafReaderContext context)
abstract SortedNumericDoubleValues	doubleValues(org.apache.lucene.index.LeafReaderContext context)	Get the current SortedNumericDoubleValues.
abstract boolean	isBigInteger()	Whether the underlying data is big integer or not.
abstract boolean	isFloatingPoint()	Whether the underlying data is floating-point or not.
abstract org.apache.lucene.index.SortedNumericDocValues	longValues(org.apache.lucene.index.LeafReaderContext context)	Get the current SortedNumericDocValues.
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

bytesValues, hasGlobalOrdinals, needsScores

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ValuesSource.Numeric EMPTY

Constructor Details

Numeric

public Numeric()

Method Details

isFloatingPoint

public abstract boolean isFloatingPoint()

Whether the underlying data is floating-point or not.

isBigInteger

public abstract boolean isBigInteger()

Whether the underlying data is big integer or not.

longValues

public abstract org.apache.lucene.index.SortedNumericDocValues longValues(org.apache.lucene.index.LeafReaderContext context)
                                                                   throws IOException

Get the current SortedNumericDocValues.

Throws:

IOException

doubleValues

public abstract SortedNumericDoubleValues doubleValues(org.apache.lucene.index.LeafReaderContext context)
                                                throws IOException

Get the current SortedNumericDoubleValues.

Throws:

IOException

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