core/org.gnit.lucenekmp.index/IndexingChain

IndexingChain

class IndexingChain(indexCreatedVersionMajor: Int, segmentInfo: SegmentInfo, directory: Directory, fieldInfos: FieldInfos.Builder, indexWriterConfig: LiveIndexWriterConfig, abortingExceptionConsumer: (Throwable) -> Unit) : Accountable

Default general purpose indexing chain, which handles indexing of all types of fields.

Constructors

IndexingChain

constructor(indexCreatedVersionMajor: Int, segmentInfo: SegmentInfo, directory: Directory, fieldInfos: FieldInfos.Builder, indexWriterConfig: LiveIndexWriterConfig, abortingExceptionConsumer: (Throwable) -> Unit)

Types

Companion

object Companion

FieldSchema

class FieldSchema(val name: String)

A schema of the field in the current document. With every new document this schema is reset. As the document fields are processed, we update the schema with options encountered in this document. Once the processing for the document is done, we compare the built schema of the current document with the corresponding FieldInfo (FieldInfo is built on a first document in the segment where we encounter this field). If there is inconsistency, we raise an error. This ensures that a field has the same data structures across all documents.

ReservedField

class ReservedField<T : IndexableField>(val delegate: T) : IndexableField

Properties

bytesUsed

val bytesUsed: Counter

childResources

open override val childResources: MutableCollection<Accountable>

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

docValuesBytePool

val docValuesBytePool: ByteBlockPool

fieldInfosBuilder

val fieldInfosBuilder: FieldInfos.Builder

storedFieldsConsumer

val storedFieldsConsumer: StoredFieldsConsumer

termsHash

val termsHash: TermsHash

termVectorsWriter

val termVectorsWriter: TermVectorsConsumer

vectorValuesConsumer

val vectorValuesConsumer: VectorValuesConsumer

Functions

abort

fun abort()

flush

fun flush(state: SegmentWriteState): Sorter.DocMap?

getHasDocValues

fun getHasDocValues(field: String): DocIdSetIterator?

markAsReserved

fun <T : IndexableField> markAsReserved(field: T): IndexingChain.ReservedField<T>

Wraps the given field in a reserved field and registers it as reserved. Only DWPT should do this to mark fields as private / reserved to prevent this fieldname to be used from the outside of the IW / DWPT eco-system

processDocument

fun processDocument(docID: Int, document: Iterable<out IndexableField>)

ramBytesUsed

open override fun ramBytesUsed(): Long

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