Class CompressionMode

A compression mode. Tells how much effort should be spent on compression and decompression of stored fields.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

System.Object

CompressionMode

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Codecs.Compressing

Assembly: Lucene.Net.dll

Syntax

public abstract class CompressionMode

Constructors

CompressionMode()

Sole constructor.

Declaration

protected CompressionMode()

Fields

FAST

A compression mode that trades compression ratio for speed. Although the compression ratio might remain high, compression and decompression are very fast. Use this mode with indices that have a high update rate but should be able to load documents from disk quickly.

Declaration

public static readonly CompressionMode FAST

Field Value

Type	Description
CompressionMode

FAST_DECOMPRESSION

This compression mode is similar to FAST but it spends more time compressing in order to improve the compression ratio. This compression mode is best used with indices that have a low update rate but should be able to load documents from disk quickly.

Declaration

public static readonly CompressionMode FAST_DECOMPRESSION

Field Value

Type	Description
CompressionMode

HIGH_COMPRESSION

A compression mode that trades speed for compression ratio. Although compression and decompression might be slow, this compression mode should provide a good compression ratio. this mode might be interesting if/when your index size is much bigger than your OS cache.

Declaration

public static readonly CompressionMode HIGH_COMPRESSION

Field Value

Type	Description
CompressionMode

Methods

NewCompressor()

Create a new Compressor instance.

Declaration

public abstract Compressor NewCompressor()

Returns

Type	Description
Compressor

NewDecompressor()

Create a new Decompressor instance.

Declaration

public abstract Decompressor NewDecompressor()

Returns

Type	Description
Decompressor