Package org.opensearch.index.codec.customcodecs

Class Lucene95CustomStoredFieldsFormat

java.lang.Object
org.apache.lucene.codecs.StoredFieldsFormat
org.opensearch.index.codec.customcodecs.Lucene95CustomStoredFieldsFormat
public class Lucene95CustomStoredFieldsFormat extends org.apache.lucene.codecs.StoredFieldsFormat
Stored field format used by pluggable codec

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MODE_KEY
    A key that we use to map to a mode

  • Constructor Summary

    Constructors
    Constructor
    Description
    Lucene95CustomStoredFieldsFormat()
    default constructor
    Lucene95CustomStoredFieldsFormat(org.opensearch.index.codec.customcodecs.Lucene95CustomCodec.Mode mode)
    Creates a new instance.
    Lucene95CustomStoredFieldsFormat(org.opensearch.index.codec.customcodecs.Lucene95CustomCodec.Mode mode, int compressionLevel)
    Creates a new instance with the specified mode and compression level.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.codecs.StoredFieldsReader
    fieldsReader(org.apache.lucene.store.Directory directory, SegmentInfo si, FieldInfos fn, org.apache.lucene.store.IOContext context)
    Returns a StoredFieldsReader to load stored fields.
    org.apache.lucene.codecs.StoredFieldsWriter
    fieldsWriter(org.apache.lucene.store.Directory directory, SegmentInfo si, org.apache.lucene.store.IOContext context)
    Returns a StoredFieldsReader to write stored fields.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • MODE_KEY

      public static final String MODE_KEY
      A key that we use to map to a mode

  • Constructor Details

    • Lucene95CustomStoredFieldsFormat

      public Lucene95CustomStoredFieldsFormat()
      default constructor

    • Lucene95CustomStoredFieldsFormat

      public Lucene95CustomStoredFieldsFormat(org.opensearch.index.codec.customcodecs.Lucene95CustomCodec.Mode mode)
      Creates a new instance.
      Parameters:
      mode - The mode represents ZSTD or ZSTDNODICT

    • Lucene95CustomStoredFieldsFormat

      public Lucene95CustomStoredFieldsFormat(org.opensearch.index.codec.customcodecs.Lucene95CustomCodec.Mode mode, int compressionLevel)
      Creates a new instance with the specified mode and compression level.
      Parameters:
      mode - The mode represents ZSTD or ZSTDNODICT
      compressionLevel - The compression level for the mode.

  • Method Details

    • fieldsReader

      public org.apache.lucene.codecs.StoredFieldsReader fieldsReader(org.apache.lucene.store.Directory directory, SegmentInfo si, FieldInfos fn, org.apache.lucene.store.IOContext context) throws IOException
      Returns a StoredFieldsReader to load stored fields.
      Specified by:
      fieldsReader in class org.apache.lucene.codecs.StoredFieldsFormat
      Parameters:
      directory - The index directory.
      si - The SegmentInfo that stores segment information.
      fn - The fieldInfos.
      context - The IOContext that holds additional details on the merge/search context.
      Throws:
      IOException

    • fieldsWriter

      public org.apache.lucene.codecs.StoredFieldsWriter fieldsWriter(org.apache.lucene.store.Directory directory, SegmentInfo si, org.apache.lucene.store.IOContext context) throws IOException
      Returns a StoredFieldsReader to write stored fields.
      Specified by:
      fieldsWriter in class org.apache.lucene.codecs.StoredFieldsFormat
      Parameters:
      directory - The index directory.
      si - The SegmentInfo that stores segment information.
      context - The IOContext that holds additional details on the merge/search context.
      Throws:
      IOException