Package org.opensearch.index.fielddata

Class GeoShapeValue.StandardGeoShapeValue

java.lang.Object

org.opensearch.index.fielddata.GeoShapeValue

org.opensearch.index.fielddata.GeoShapeValue.StandardGeoShapeValue

Enclosing class:

GeoShapeValue

public static class GeoShapeValue.StandardGeoShapeValue
extends GeoShapeValue

This is the standard implementation of the GeoShapeValue interface for iterating over the doc values for a GeoShape field.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.index.fielddata.GeoShapeValue

GeoShapeValue.EmptyGeoShapeValue, GeoShapeValue.MissingGeoShapeValue, GeoShapeValue.StandardGeoShapeValue

Constructor Summary

Constructors

Constructor	Description
StandardGeoShapeValue(org.apache.lucene.index.BinaryDocValues binaryDocValues, String fieldName)

Method Summary

Modifier and Type	Method	Description
boolean	advanceExact(int doc)	Advance this instance to the given document id
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

StandardGeoShapeValue

public StandardGeoShapeValue(org.apache.lucene.index.BinaryDocValues binaryDocValues,
 String fieldName)

Method Details

advanceExact

public boolean advanceExact(int doc)
                     throws IOException

Advance this instance to the given document id

Specified by:

advanceExact in class GeoShapeValue

Returns:

true if there is a value for this document

Throws:

IOException

nextValue

public GeoShapeDocValue nextValue()
                           throws IOException

Return the next value associated with the current document.

Specified by:

nextValue in class GeoShapeValue

Returns:

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

Throws:

IOException