core/org.gnit.lucenekmp.index/FieldInfo

FieldInfo

class FieldInfo(val name: String, val number: Int, storeTermVector: Boolean, omitNorms: Boolean, storePayloads: Boolean, indexOptions: IndexOptions, docValues: DocValuesType, docValuesSkipIndex: DocValuesSkipIndexType, dvGen: Long, attributes: Map<String, String>, pointDimensionCount: Int, pointIndexDimensionCount: Int, pointNumBytes: Int, vectorDimension: Int, vectorEncoding: VectorEncoding, vectorSimilarityFunction: VectorSimilarityFunction, softDeletesField: Boolean, isParentField: Boolean)

Access to the Field Info file that describes document fields and whether or not they are indexed. Each segment has a separate Field Info file. Objects of this class are thread-safe for multiple readers, but only one thread can be adding documents at a time, with no other reader or writer threads accessing this object.

Constructors

constructor(name: String, number: Int, storeTermVector: Boolean, omitNorms: Boolean, storePayloads: Boolean, indexOptions: IndexOptions, docValues: DocValuesType, docValuesSkipIndex: DocValuesSkipIndexType, dvGen: Long, attributes: Map<String, String>, pointDimensionCount: Int, pointIndexDimensionCount: Int, pointNumBytes: Int, vectorDimension: Int, vectorEncoding: VectorEncoding, vectorSimilarityFunction: VectorSimilarityFunction, softDeletesField: Boolean, isParentField: Boolean)

Types

object Companion

Properties

var docValuesGen: Long

var docValuesType: DocValuesType

Returns DocValuesType of the docValues; this is DocValuesType.NONE if the field has no docvalues.

val indexOptions: IndexOptions

Returns IndexOptions for the field, or IndexOptions.NONE if the field is not indexed

val isParentField: Boolean

Returns true if this field is configured and used as the parent document field field. See IndexWriterConfig.setParentField

isSoftDeletesField

val isSoftDeletesField: Boolean

Returns true if this field is configured and used as the soft-deletes field. See

val name: String

Returns name of this field

val number: Int

Returns the field number

pointDimensionCount

var pointDimensionCount: Int

If both of these are positive it means this field indexed points (see [ ]).

pointIndexDimensionCount

var pointIndexDimensionCount: Int

Return point data dimension count

var pointNumBytes: Int

Return number of bytes per dimension

vectorDimension

val vectorDimension: Int

Returns the number of dimensions of the vector value

val vectorEncoding: VectorEncoding

Returns the number of dimensions of the vector value

vectorSimilarityFunction

val vectorSimilarityFunction: VectorSimilarityFunction

Returns VectorSimilarityFunction for the field

Functions

fun attributes(): Map<String, String>

Returns internal codec attributes map.

checkConsistency

fun checkConsistency()

Check correctness of the FieldInfo options

docValuesSkipIndexType

fun docValuesSkipIndexType(): DocValuesSkipIndexType

Returns true if, and only if, this field has a skip index.

fun getAttribute(key: String?): String?

Get a codec attribute value, or null if it does not exist

fun hasNorms(): Boolean

Returns true if this field actually has any norms.

fun hasPayloads(): Boolean

Returns true if any payloads exist for this field.

fun hasTermVectors(): Boolean

Returns true if any term vectors exist for this field.

hasVectorValues

fun hasVectorValues(): Boolean

Returns whether any (numeric) vector values exist for this field

fun omitsNorms(): Boolean

Returns true if norms are explicitly omitted for this field

fun putAttribute(key: String, value: String): String?

Puts a codec attribute value.

fun setOmitsNorms()

Omit norms for this field.

setPointDimensions

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

Record that this field is indexed with points, with the specified number of dimensions and bytes per dimension.

setStorePayloads

fun setStorePayloads()

setStoreTermVectors

fun setStoreTermVectors()

verifySameSchema

fun verifySameSchema(o: FieldInfo)

Verify that the provided FieldInfo has the same schema as this FieldInfo