core/org.gnit.lucenekmp.codecs/TermVectorsReader

TermVectorsReader

abstract class TermVectorsReader : TermVectors, Cloneable<TermVectorsReader> , AutoCloseable

Codec API for reading term vectors:

Inheritors

Lucene90CompressingTermVectorsReader

Properties

open val mergeInstance: TermVectorsReader

Functions

abstract fun checkIntegrity()

Checks consistency of this reader.

abstract override fun clone(): TermVectorsReader

Create a clone that one caller at a time may use to read term vectors.

expect abstract fun close()

abstract fun get(doc: Int): Fields?

Returns term vectors for this document, or null if term vectors were not indexed.

fun get(doc: Int, field: String?): Terms?

Retrieve term vector for this document and field, or null if term vectors were not indexed.

open fun prefetch(docID: Int)

Optional method: Give a hint to this TermVectors instance that the given document will be read in the near future. This typically delegates to IndexInput.prefetch and is useful to parallelize I/O across multiple documents.