core/org.gnit.lucenekmp.index/TermVectors

TermVectors

abstract class TermVectors

API for reading term vectors.

NOTE: This class is not thread-safe and should only be consumed in the thread where it was acquired.

Inheritors

TermVectorsReader

Types

Companion

object Companion

Functions

get

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.

prefetch

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.