Package org.apache.lucene.codecs
Class PointsReader
- java.lang.Object
-
- org.apache.lucene.codecs.PointsReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
Lucene90PointsReader
public abstract class PointsReader extends Object implements Closeable
Abstract API to visit point values.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedPointsReader()Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidcheckIntegrity()Checks consistency of this reader.PointsReadergetMergeInstance()Returns an instance optimized for merging.abstract PointValuesgetValues(String field)ReturnPointValuesfor the givenfield.
-
-
-
Method Detail
-
checkIntegrity
public abstract void checkIntegrity() throws IOExceptionChecks consistency of this reader.Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.
- Throws:
IOException- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getValues
public abstract PointValues getValues(String field) throws IOException
ReturnPointValuesfor the givenfield. The behavior is undefined if the given field doesn't have points enabled on itsFieldInfo.- Throws:
IOException
-
getMergeInstance
public PointsReader getMergeInstance()
Returns an instance optimized for merging. This instance may only be used in the thread that acquires it.The default implementation returns
this
-
-