core/org.gnit.lucenekmp.index/SegmentWriteState

SegmentWriteState

Holder class for common parameters used during write.

Constructors

constructor(infoStream: InfoStream?, directory: Directory, segmentInfo: SegmentInfo, fieldInfos: FieldInfos?, segUpdates: BufferedUpdates?, context: IOContext)

Sole constructor.

constructor(infoStream: InfoStream?, directory: Directory, segmentInfo: SegmentInfo, fieldInfos: FieldInfos?, segUpdates: BufferedUpdates?, context: IOContext, segmentSuffix: String)

Constructor which takes segment suffix.

constructor(state: SegmentWriteState, segmentSuffix: String)

Create a shallow copy of SegmentWriteState with a new segment suffix.

Properties

context

val context: IOContext

IOContext for all writes; you should pass this to .

delCountOnFlush

var delCountOnFlush: Int

Number of deleted documents set while flushing the segment.

directory

val directory: Directory

Directory where this segment will be written to.

fieldInfos

val fieldInfos: FieldInfos?

FieldInfos describing all fields in this segment.

infoStream

val infoStream: InfoStream?

InfoStream used for debugging messages.

liveDocs

var liveDocs: FixedBitSet?

FixedBitSet recording live documents; this is only set if there is one or more deleted documents.

segmentInfo

val segmentInfo: SegmentInfo

SegmentInfo describing this segment.

segmentSuffix

val segmentSuffix: String

Unique suffix for any postings files written for this segment. PerFieldPostingsFormat sets this for each of the postings formats it wraps. If you create a new PostingsFormat then any files you write/read must be derived using this suffix (use ).

segUpdates

val segUpdates: BufferedUpdates?

Deletes and updates to apply while we are flushing the segment. A Term is enrolled in here if it was deleted/updated at one point, and it's mapped to the docIDUpto, meaning any docID < docIDUpto containing this term should be deleted/updated.

softDelCountOnFlush

var softDelCountOnFlush: Int

Number of only soft deleted documents set while flushing the segment.