Module org.apache.lucene.backward_codecs
Package org.apache.lucene.backward_codecs.lucene84

Class Lucene84Codec

java.lang.Object
org.apache.lucene.codecs.Codec
org.apache.lucene.backward_codecs.lucene84.Lucene84Codec
All Implemented Interfaces:
NamedSPILoader.NamedSPI
public class Lucene84Codec extends Codec
Implements the Lucene 8.4 index format, with configurable per-field postings and docvalues formats.

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

See Also:

  • Field Details

  • Constructor Details

    • Lucene84Codec

      public Lucene84Codec()
      Instantiates a new codec.

    • Lucene84Codec

      public Lucene84Codec(Lucene50StoredFieldsFormat.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 StoredFieldsFormat storedFieldsFormat()
      Description copied from class: Codec
      Encodes/decodes stored fields
      Specified by:
      storedFieldsFormat in class Codec

    • termVectorsFormat

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

    • postingsFormat

      public 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 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 CompoundFormat compoundFormat()
      Description copied from class: Codec
      Encodes/decodes compound files
      Specified by:
      compoundFormat in class Codec

    • pointsFormat

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

    • knnVectorsFormat

      public 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 "Lucene84".

      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 "Lucene80".

      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 NormsFormat normsFormat()
      Description copied from class: Codec
      Encodes/decodes document normalization values
      Specified by:
      normsFormat in class Codec