core/org.gnit.lucenekmp.index/Fields

Fields

abstract class Fields : Iterable<String>

Provides a Terms index for fields that have it, and lists which fields do. This is primarily an internal/experimental API (see FieldsProducer), although it is also used to expose the set of term vectors per document.

Inheritors

FieldsProducer

FilterFields

MultiFields

Types

Companion

object Companion

Functions

iterator

abstract operator override fun iterator(): MutableIterator<String>

Returns an iterator that will step through all fields names. This will not return null.

size

abstract fun size(): Int

Returns the number of fields or -1 if the number of distinct field names is unknown. If >= 0, .iterator will return as many field names.

terms

abstract fun terms(field: String?): Terms?

Get the Terms for this field. This will return null if the field does not exist.