Class CompressingTermVectorsFormat

A TermVectorsFormat that compresses chunks of documents together in order to improve the compression ratio.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
TermVectorsFormat
CompressingTermVectorsFormat
Lucene42TermVectorsFormat
Namespace: Lucene.Net.Codecs.Compressing
Assembly: Lucene.Net.dll
Syntax
public class CompressingTermVectorsFormat : TermVectorsFormat

Constructors

| Improve this Doc View Source

CompressingTermVectorsFormat(String, String, CompressionMode, Int32)

Create a new CompressingTermVectorsFormat.

formatName is the name of the format. this name will be used in the file formats to perform codec header checks (CheckHeader(DataInput, String, Int32, Int32)).

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 CompressingTermVectorsFormats 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).

Declaration
public CompressingTermVectorsFormat(string formatName, string segmentSuffix, CompressionMode compressionMode, int chunkSize)
Parameters
Type Name Description
System.String formatName

The name of the StoredFieldsFormat.

System.String segmentSuffix

A suffix to append to files created by this format.

CompressionMode compressionMode

The CompressionMode to use.

System.Int32 chunkSize

The minimum number of bytes of a single chunk of stored documents.

See Also

Methods

| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
| Improve this Doc View Source

VectorsReader(Directory, SegmentInfo, FieldInfos, IOContext)

Declaration
public override sealed TermVectorsReader VectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)
Parameters
Type Name Description
Directory directory
SegmentInfo segmentInfo
FieldInfos fieldInfos
IOContext context
Returns
Type Description
TermVectorsReader
Overrides
| Improve this Doc View Source

VectorsWriter(Directory, SegmentInfo, IOContext)

Declaration
public override sealed TermVectorsWriter VectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)
Parameters
Type Name Description
Directory directory
SegmentInfo segmentInfo
IOContext context
Returns
Type Description
TermVectorsWriter
Overrides