core/org.gnit.lucenekmp.index/FieldInvertState

FieldInvertState

class FieldInvertState(val indexCreatedVersionMajor: Int, val name: String?, val indexOptions: IndexOptions?)

This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field.

Constructors

FieldInvertState

constructor(indexCreatedVersionMajor: Int, name: String?, indexOptions: IndexOptions?)

constructor(indexCreatedVersionMajor: Int, name: String?, indexOptions: IndexOptions?, position: Int, length: Int, numOverlap: Int, offset: Int, maxTermFrequency: Int, uniqueTermCount: Int)

Creates {code FieldInvertState} for the specified field name and values for all fields.

Properties

attributeSource

var attributeSource: AttributeSource?

indexCreatedVersionMajor

val indexCreatedVersionMajor: Int

Return the version that was used to create the index, or 6 if it was created before 7.0.

indexOptions

val indexOptions: IndexOptions?

Get the index options for this field

lastPosition

var lastPosition: Int

lastStartOffset

var lastStartOffset: Int

length

var length: Int

Set length value.

maxTermFrequency

var maxTermFrequency: Int

Get the maximum term-frequency encountered for any term in the field. A field containing "the quick brown fox jumps over the lazy dog" would have a value of 2, because "the" appears twice.

name

val name: String?

Return the field's name

numOverlap

var numOverlap: Int

Set number of terms with positionIncrement == 0.

offset

var offset: Int

Get end offset of the last processed term.

offsetAttribute

var offsetAttribute: OffsetAttribute?

payloadAttribute