core/org.gnit.lucenekmp.index/FieldInfos

FieldInfos

open class FieldInfos(infos: Array<FieldInfo>) : Iterable<FieldInfo>

Collection of FieldInfos (accessible by number or by name).

Constructors

FieldInfos

constructor(infos: Array<FieldInfo>)

Types

Builder

class Builder(globalFieldNumbers: FieldInfos.FieldNumbers)

Companion

object Companion

FieldNumbers

class FieldNumbers(softDeletesFieldName: String?, parentFieldName: String?)

Properties

parentField

val parentField: String?

Returns the parent document field name if exists; otherwise returns null

softDeletesField

val softDeletesField: String?

Returns the soft-deletes field name if exists; otherwise returns null

Functions

fieldInfo

open fun fieldInfo(fieldNumber: Int): FieldInfo?

Return the fieldinfo object referenced by the fieldNumber.

open fun fieldInfo(fieldName: String?): FieldInfo?

Return the fieldinfo object referenced by the field name

hasDocValues

open fun hasDocValues(): Boolean

Returns true if any fields have DocValues

hasFreq

open fun hasFreq(): Boolean

Returns true if any fields have freqs

hasNorms

open fun hasNorms(): Boolean

Returns true if any fields have norms

hasOffsets

open fun hasOffsets(): Boolean

Returns true if any fields have offsets

hasPayloads

open fun hasPayloads(): Boolean

Returns true if any fields have payloads

hasPointValues

open fun hasPointValues(): Boolean

Returns true if any fields have PointValues

hasPostings

open fun hasPostings(): Boolean

Returns true if any fields have postings

hasProx

open fun hasProx(): Boolean

Returns true if any fields have positions

hasTermVectors

open fun hasTermVectors(): Boolean

Returns true if any fields have term vectors

hasVectorValues

fun hasVectorValues(): Boolean

Returns true if any fields have vector values

iterator

open operator override fun iterator(): MutableIterator<FieldInfo>

Returns an iterator over all the fieldinfo objects present, ordered by ascending field number

size

open fun size(): Int

Returns the number of fields