Package org.elasticsearch.search.aggregations.support

Class ValuesSource.Numeric.Script

java.lang.Object

org.elasticsearch.search.aggregations.support.ValuesSource

org.elasticsearch.search.aggregations.support.ValuesSource.Numeric

org.elasticsearch.search.aggregations.support.ValuesSource.Numeric.Script

Enclosing class:

ValuesSource.Numeric

public static class ValuesSource.Numeric.Script
extends ValuesSource.Numeric

ValuesSource implementation for stand alone scripts returning a Numeric value

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSource.Numeric

EMPTY

Constructor Summary

Constructors

Constructor	Description
Script(AggregationScript.LeafFactory script, ValueType scriptValueType)

Method Summary

Modifier and Type	Method	Description
SortedBinaryDocValues	bytesValues(org.apache.lucene.index.LeafReaderContext context)	Get a byte array like view into the values.
SortedNumericDoubleValues	doubleValues(org.apache.lucene.index.LeafReaderContext context)	Get a double precision floating point view into the values in this leaf.
boolean	isFloatingPoint()	Are values of this field better represented as a double precision floating point numbers (true) or 64 bit signed numbers (false)?
org.apache.lucene.index.SortedNumericDocValues	longValues(org.apache.lucene.index.LeafReaderContext context)	Get a 64 bit signed view into the values in this leaf.
boolean	needsScores()	Whether this values source needs scores.

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

docsWithValue, roundingPreparer

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

hasOrdinals

Methods inherited from class java.lang.Object

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

Constructor Details

Script

public Script(AggregationScript.LeafFactory script,
 ValueType scriptValueType)

Method Details

isFloatingPoint

public boolean isFloatingPoint()

Description copied from class: ValuesSource.Numeric

Are values of this field better represented as a double precision floating point numbers (true) or 64 bit signed numbers (false)?

Aggregations may, if they feel it is important, use this to pick which of ValuesSource.Numeric.longValues(org.apache.lucene.index.LeafReaderContext) and ValuesSource.Numeric.doubleValues(org.apache.lucene.index.LeafReaderContext) is better for the field values. Most metric aggregations are quite happy to operate on floating point numbers all the time and never call this. Bucketing aggregations that want to enumerate all values (like TermsAggregator) will want to check this but bucketing aggregations that just compare values (RangeAggregator) are, like metric aggregators, fine ignoring it.

Specified by:

isFloatingPoint in class ValuesSource.Numeric

longValues

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

Description copied from class: ValuesSource.Numeric

Get a 64 bit signed view into the values in this leaf.

If the values have precision beyond the decimal point then they'll be "narrowed" but they'll accurately represent values up to Long.MAX_VALUE.

Specified by:

longValues in class ValuesSource.Numeric

Throws:

IOException

doubleValues

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

Description copied from class: ValuesSource.Numeric

Get a double precision floating point view into the values in this leaf.

These values will preserve any precision beyond the decimal point but are limited to double's standard 53 bit mantissa. If the "native" field has values that can't be accurately represented in those 53 bits they'll be "widened"

Specified by:

doubleValues in class ValuesSource.Numeric

Throws:

IOException

bytesValues

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

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

Throws:

IOException

needsScores

public boolean needsScores()

Description copied from class: ValuesSource

Whether this values source needs scores.

Overrides:

needsScores in class ValuesSource