core/org.gnit.lucenekmp.index/IndexingChain/FieldSchema

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.

Constructors

constructor(name: String)

Types

object Companion

Properties

val attributes: MutableMap<String, String>

docValuesSkipIndex

var docValuesSkipIndex: DocValuesSkipIndexType

var docValuesType: DocValuesType

var indexOptions: IndexOptions

val name: String

var omitNorms: Boolean

pointDimensionCount

var pointDimensionCount: Int

pointIndexDimensionCount

var pointIndexDimensionCount: Int

var pointNumBytes: Int

storeTermVector

var storeTermVector: Boolean

vectorDimension

var vectorDimension: Int

var vectorEncoding: VectorEncoding

vectorSimilarityFunction

var vectorSimilarityFunction: VectorSimilarityFunction

Functions

fun <T : Enum<*>> assertSame(label: String, expected: T, given: T)

fun assertSame(label: String, expected: Boolean, given: Boolean)

fun assertSame(label: String, expected: Int, given: Int)

assertSameSchema

fun assertSameSchema(fi: FieldInfo)

fun raiseNotSame(label: String, expected: Any, given: Any)

fun reset(doc: Int)

fun setDocValues(newDocValuesType: DocValuesType, newDocValuesSkipIndex: DocValuesSkipIndexType)

setIndexOptions

fun setIndexOptions(newIndexOptions: IndexOptions, newOmitNorms: Boolean, newStoreTermVector: Boolean)

fun setPoints(dimensionCount: Int, indexDimensionCount: Int, numBytes: Int)

fun setVectors(encoding: VectorEncoding, similarityFunction: VectorSimilarityFunction, dimension: Int)

updateAttributes

fun updateAttributes(attrs: MutableMap<String, String>)