Class Lucene90CompressingTermVectorsFormat

java.lang.Object
org.apache.lucene.codecs.TermVectorsFormat
org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingTermVectorsFormat
Direct Known Subclasses:
Lucene90TermVectorsFormat

public class Lucene90CompressingTermVectorsFormat extends TermVectorsFormat
A TermVectorsFormat that compresses chunks of documents together in order to improve the compression ratio.
  • Field Details

    • formatName

      private final String formatName
    • segmentSuffix

      private final String segmentSuffix
    • compressionMode

      private final CompressionMode compressionMode
    • chunkSize

      private final int chunkSize
    • blockSize

      private final int blockSize
    • maxDocsPerChunk

      private final int maxDocsPerChunk
  • Constructor Details

    • Lucene90CompressingTermVectorsFormat

      public Lucene90CompressingTermVectorsFormat(String formatName, String segmentSuffix, CompressionMode compressionMode, int chunkSize, int maxDocsPerChunk, int blockSize)
      Create a new Lucene90CompressingTermVectorsFormat.

      formatName is the name of the format. This name will be used in the file formats to perform codec header checks.

      The compressionMode parameter allows you to choose between compression algorithms that have various compression and decompression speeds so that you can pick the one that best fits your indexing and searching throughput. You should never instantiate two Lucene90CompressingTermVectorsFormats that have the same name but different CompressionModes.

      chunkSize is the minimum byte size of a chunk of documents. Higher values of chunkSize should improve the compression ratio but will require more memory at indexing time and might make document loading a little slower (depending on the size of your OS cache compared to the size of your index).

      Parameters:
      formatName - the name of the StoredFieldsFormat
      segmentSuffix - a suffix to append to files created by this format
      compressionMode - the CompressionMode to use
      chunkSize - the minimum number of bytes of a single chunk of stored documents
      maxDocsPerChunk - the maximum number of documents in a single chunk
      blockSize - the number of chunks to store in an index block.
      See Also:
  • Method Details