Class Lucene50CompressingTermVectorsFormat
- Direct Known Subclasses:
Lucene50TermVectorsFormat
TermVectorsFormat that compresses chunks of documents together in order to improve the
compression ratio.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final intblock sizeprotected final intchunk sizeprotected final CompressionModecompression modeprotected final Stringformat nameprotected final intmax docs per chunkprotected final Stringsegment suffix -
Constructor Summary
ConstructorsConstructorDescriptionLucene50CompressingTermVectorsFormat(String formatName, String segmentSuffix, CompressionMode compressionMode, int chunkSize, int maxDocsPerChunk, int blockSize) Create a newLucene50CompressingTermVectorsFormat. -
Method Summary
Modifier and TypeMethodDescriptiontoString()final TermVectorsReadervectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)
-
Field Details
-
formatName
format name -
segmentSuffix
segment suffix -
compressionMode
compression mode -
chunkSize
protected final int chunkSizechunk size -
blockSize
protected final int blockSizeblock size -
maxDocsPerChunk
protected final int maxDocsPerChunkmax docs per chunk
-
-
Constructor Details
-
Lucene50CompressingTermVectorsFormat
public Lucene50CompressingTermVectorsFormat(String formatName, String segmentSuffix, CompressionMode compressionMode, int chunkSize, int maxDocsPerChunk, int blockSize) Create a newLucene50CompressingTermVectorsFormat.formatNameis the name of the format. This name will be used in the file formats to performcodec header checks.The
compressionModeparameter 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 twoLucene50CompressingTermVectorsFormats that have the same name but differentCompressionModes.chunkSizeis the minimum byte size of a chunk of documents. Higher values ofchunkSizeshould 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 theStoredFieldsFormatsegmentSuffix- a suffix to append to files created by this formatcompressionMode- theCompressionModeto usechunkSize- the minimum number of bytes of a single chunk of stored documentsmaxDocsPerChunk- the maximum number of documents in a single chunkblockSize- the number of chunks to store in an index block.- See Also:
-
-
Method Details
-
vectorsReader
public final TermVectorsReader vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) throws IOException - Specified by:
vectorsReaderin classTermVectorsFormat- Throws:
IOException
-
vectorsWriter
public TermVectorsWriter vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context) throws IOException - Specified by:
vectorsWriterin classTermVectorsFormat- Throws:
IOException
-
toString
-