Package org.opensearch.index.fielddata

Class GeoShapeValue

java.lang.Object

org.opensearch.index.fielddata.GeoShapeValue

Direct Known Subclasses:

GeoShapeValue.EmptyGeoShapeValue, GeoShapeValue.MissingGeoShapeValue, GeoShapeValue.StandardGeoShapeValue

public abstract class GeoShapeValue
extends Object

A stateful lightweight iterator interface to read the stored form of Geometry aka LatLonShapeDocValuesField from Lucene per document. Check GeoShapeFieldMapper for details how we converted the Geometry to LatLonShapeDocValuesField

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoShapeValue.EmptyGeoShapeValue	This is the representation of an EmptyGeoShapeValue
static class	GeoShapeValue.MissingGeoShapeValue	The MissingGeoShapeValue is used when on a particular document the GeoShape field is not present and user has provided a missing/default GeoShape value in the input which should be used.
static class	GeoShapeValue.StandardGeoShapeValue	This is the standard implementation of the GeoShapeValue interface for iterating over the doc values for a GeoShape field.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeoShapeValue()	Creates a new GeoShapeValue instance

Method Summary

Modifier and Type	Method	Description
abstract boolean	advanceExact(int doc)	Advance this instance to the given document id
abstract GeoShapeDocValue	nextValue()	Return the next value associated with the current document.

Methods inherited from class java.lang.Object

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

Constructor Details

GeoShapeValue

protected GeoShapeValue()

Creates a new GeoShapeValue instance

Method Details

advanceExact

public abstract boolean advanceExact(int doc)
                              throws IOException

Advance this instance to the given document id

Returns:

true if there is a value for this document

Throws:

IOException

nextValue

public abstract GeoShapeDocValue nextValue()
                                    throws IOException

Return the next value associated with the current document.

Returns:

the next value for the current docID set to advanceExact(int).

Throws:

IOException