Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Functions

Link copied to clipboard
open override fun addPosition(position: Int, startOffset: Int, endOffset: Int, payload: BytesRef?)

Adds a term position and offsets

Link copied to clipboard
open override fun addProx(numProx: Int, positions: DataInput?, offsets: DataInput?)

Called by IndexWriter when writing new segments.

Link copied to clipboard
open override fun close()
Link copied to clipboard
open override fun finish(numDocs: Int)

Called before .close, passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to .startDocument, but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.

Link copied to clipboard
open override fun finishDocument()

Called after a doc and all its fields have been added.

Link copied to clipboard
open override fun finishField()

Called after a field and all its terms have been added.

Link copied to clipboard
open fun finishTerm()

Called after a term and all its positions have been added.

Link copied to clipboard
open override fun merge(mergeState: MergeState): Int

Merges in the term vectors from the readers in mergeState. The default implementation skips over deleted documents, and uses .startDocument, .startField, .startTerm, .addPosition, and .finish, returning the number of documents that were written. Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).

Link copied to clipboard
open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

Link copied to clipboard
open override fun startDocument(numVectorFields: Int)

Called before writing the term vectors of the document. .startField will be called numVectorFields times. Note that if term vectors are enabled, this is called even if the document has no vector fields, in this case numVectorFields will be zero.

Link copied to clipboard
open override fun startField(info: FieldInfo?, numTerms: Int, positions: Boolean, offsets: Boolean, payloads: Boolean)

Called before writing the terms of the field. .startTerm will be called numTerms times.

Link copied to clipboard
open override fun startTerm(term: BytesRef?, freq: Int)

Adds a term and its term frequency freq. If this field has positions and/or offsets enabled, then .addPosition will be called freq * times respectively.

Link copied to clipboard

Returns true if we should recompress this reader, even though we could bulk merge compressed data