Codec

abstract class Codec : NamedSPILoader.NamedSPI

Encodes/decodes an inverted index segment.

Note, when extending this class, the name (.getName) is written into the index. In order for the segment to be read, the name must resolve to your implementation via .forName. This method uses Java's ServiceLoader (SPI) to resolve codec names.

If you implement your own codec, make sure that it has a no-arg constructor so SPI can load it.

Parameters

name

Returns this codec's name.

Inheritors

FilterCodec

Lucene101Codec

Types

Companion

object Companion

Properties

name

open override val name: String

Functions

compoundFormat

abstract fun compoundFormat(): CompoundFormat

Encodes/decodes compound files

docValuesFormat

abstract fun docValuesFormat(): DocValuesFormat

Encodes/decodes docvalues

fieldInfosFormat

abstract fun fieldInfosFormat(): FieldInfosFormat

Encodes/decodes field infos file

knnVectorsFormat

abstract fun knnVectorsFormat(): KnnVectorsFormat

Encodes/decodes numeric vector fields

liveDocsFormat

abstract fun liveDocsFormat(): LiveDocsFormat

Encodes/decodes live docs

normsFormat

abstract fun normsFormat(): NormsFormat

Encodes/decodes document normalization values

pointsFormat

abstract fun pointsFormat(): PointsFormat

Encodes/decodes points index

postingsFormat

abstract fun postingsFormat(): PostingsFormat

Encodes/decodes postings

segmentInfoFormat

abstract fun segmentInfoFormat(): SegmentInfoFormat

Encodes/decodes segment info file

storedFieldsFormat

abstract fun storedFieldsFormat(): StoredFieldsFormat

Encodes/decodes stored fields

termVectorsFormat

abstract fun termVectorsFormat(): TermVectorsFormat

Encodes/decodes term vectors

toString

open override fun toString(): String

returns the codec's name. Subclasses can override to provide more detail (such as parameters).