Package org.opensearch.geo.search.aggregations.bucket.geogrid.cells

Class GeoShapeCellIdSource

java.lang.Object

org.opensearch.search.aggregations.support.ValuesSource

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

org.opensearch.geo.search.aggregations.bucket.geogrid.cells.GeoShapeCellIdSource

public class GeoShapeCellIdSource
extends ValuesSource.Numeric

ValueSource class which converts the GeoShapeValue to numeric long values for bucketing. This class uses the GeoShapeCellIdSource.GeoShapeLongEncoder to encode the geo_shape to Long values which can be iterated to do the bucket aggregation.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoShapeCellIdSource.GeoShapeLongEncoder	Encoder to encode the GeoShapes to the specific long values for the aggregation.

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

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

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 inherited from class org.opensearch.search.aggregations.support.ValuesSource.Numeric

EMPTY

Constructor Summary

Constructors

Constructor	Description
GeoShapeCellIdSource(ValuesSource.GeoShape geoShape, int precision, GeoBoundingBox geoBoundingBox, GeoShapeCellIdSource.GeoShapeLongEncoder encoder)

Method Summary

Modifier and Type	Method	Description
SortedBinaryDocValues	bytesValues(LeafReaderContext context)	Get the current SortedBinaryDocValues.
SortedNumericDoubleValues	doubleValues(LeafReaderContext context)	Get the current SortedNumericDoubleValues.
boolean	isBigInteger()	Whether the underlying data is big integer or not.
boolean	isFloatingPoint()	Whether the underlying data is floating-point or not.
SortedNumericDocValues	longValues(LeafReaderContext context)	Get the current SortedNumericDocValues.

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

docsWithValue, roundingPreparer

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

Constructor Details

GeoShapeCellIdSource

public GeoShapeCellIdSource(ValuesSource.GeoShape geoShape,
 int precision,
 GeoBoundingBox geoBoundingBox,
 GeoShapeCellIdSource.GeoShapeLongEncoder encoder)

Method Details

bytesValues

public SortedBinaryDocValues bytesValues(LeafReaderContext context)
                                  throws IOException

Get the current SortedBinaryDocValues.

Specified by:

bytesValues in class ValuesSource

Parameters:

context - LeafReaderContext

Throws:

IOException

isFloatingPoint

public boolean isFloatingPoint()

Whether the underlying data is floating-point or not.

Specified by:

isFloatingPoint in class ValuesSource.Numeric

isBigInteger

public boolean isBigInteger()

Whether the underlying data is big integer or not.

Specified by:

isBigInteger in class ValuesSource.Numeric

longValues

public SortedNumericDocValues longValues(LeafReaderContext context)

Get the current SortedNumericDocValues.

Specified by:

longValues in class ValuesSource.Numeric

Parameters:

context - LeafReaderContext

doubleValues

public SortedNumericDoubleValues doubleValues(LeafReaderContext context)

Get the current SortedNumericDoubleValues.

Specified by:

doubleValues in class ValuesSource.Numeric

Parameters:

context - LeafReaderContext