Package org.apache.lucene.codecs.lucene91

Class Lucene91Codec

java.lang.Object
org.apache.lucene.codecs.Codec
org.apache.lucene.codecs.lucene91.Lucene91Codec
All Implemented Interfaces:
NamedSPILoader.NamedSPI
public class Lucene91Codec extends Codec
Implements the Lucene 9.1 index format

If you want to reuse functionality of this codec in another codec, extend FilterCodec.

See Also:
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Constructor Details

    • Lucene91Codec

      public Lucene91Codec()
      Instantiates a new codec.

    • Lucene91Codec

      public Lucene91Codec(Lucene91Codec.Mode mode)
      Instantiates a new codec, specifying the stored fields compression mode to use.
      Parameters:
      mode - stored fields compression mode to use for newly flushed/merged segments.

  • Method Details

    • storedFieldsFormat

      public final StoredFieldsFormat storedFieldsFormat()
      Description copied from class: Codec
      Encodes/decodes stored fields
      Specified by:
      storedFieldsFormat in class Codec

    • termVectorsFormat

      public final TermVectorsFormat termVectorsFormat()
      Description copied from class: Codec
      Encodes/decodes term vectors
      Specified by:
      termVectorsFormat in class Codec

    • postingsFormat

      public final PostingsFormat postingsFormat()
      Description copied from class: Codec
      Encodes/decodes postings
      Specified by:
      postingsFormat in class Codec

    • fieldInfosFormat

      public final FieldInfosFormat fieldInfosFormat()
      Description copied from class: Codec
      Encodes/decodes field infos file
      Specified by:
      fieldInfosFormat in class Codec

    • segmentInfoFormat

      public final SegmentInfoFormat segmentInfoFormat()
      Description copied from class: Codec
      Encodes/decodes segment info file
      Specified by:
      segmentInfoFormat in class Codec

    • liveDocsFormat

      public final LiveDocsFormat liveDocsFormat()
      Description copied from class: Codec
      Encodes/decodes live docs
      Specified by:
      liveDocsFormat in class Codec

    • compoundFormat

      public final CompoundFormat compoundFormat()
      Description copied from class: Codec
      Encodes/decodes compound files
      Specified by:
      compoundFormat in class Codec

    • pointsFormat

      public final PointsFormat pointsFormat()
      Description copied from class: Codec
      Encodes/decodes points index
      Specified by:
      pointsFormat in class Codec

    • knnVectorsFormat

      public final KnnVectorsFormat knnVectorsFormat()
      Description copied from class: Codec
      Encodes/decodes numeric vector fields
      Specified by:
      knnVectorsFormat in class Codec

    • getPostingsFormatForField

      public PostingsFormat getPostingsFormatForField(String field)
      Returns the postings format that should be used for writing new segments of field.

      The default implementation always returns "Lucene90".

      WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation,

    • getDocValuesFormatForField

      public DocValuesFormat getDocValuesFormatForField(String field)
      Returns the docvalues format that should be used for writing new segments of field .

      The default implementation always returns "Lucene90".

      WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation.

    • getKnnVectorsFormatForField

      public KnnVectorsFormat getKnnVectorsFormatForField(String field)
      Returns the vectors format that should be used for writing new segments of field

      The default implementation always returns "Lucene91".

      WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation.

    • docValuesFormat

      public final DocValuesFormat docValuesFormat()
      Description copied from class: Codec
      Encodes/decodes docvalues
      Specified by:
      docValuesFormat in class Codec

    • normsFormat

      public final NormsFormat normsFormat()
      Description copied from class: Codec
      Encodes/decodes document normalization values
      Specified by:
      normsFormat in class Codec