Class CompressingCodec

A codec that uses Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat for its stored fields and delegates to Lucene.Net.Codecs.Lucene46.Lucene46Codec for everything else.

Inheritance

object

Codec

FilterCodec

CompressingCodec

DummyCompressingCodec

FastCompressingCodec

FastDecompressionCompressingCodec

HighCompressionCompressingCodec

Inherited Members

FilterCodec.m_delegate

FilterCodec.DocValuesFormat

FilterCodec.FieldInfosFormat

FilterCodec.LiveDocsFormat

FilterCodec.NormsFormat

FilterCodec.PostingsFormat

FilterCodec.SegmentInfoFormat

Codec.SetCodecFactory(ICodecFactory)

Codec.GetCodecFactory()

Codec.Name

Codec.ForName(string)

Codec.AvailableCodecs

Codec.Default

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Codecs.Compressing

Assembly: Lucene.Net.TestFramework.dll

Syntax

public abstract class CompressingCodec : FilterCodec

Constructors

CompressingCodec(CompressionMode, int)

Creates a compressing codec with an empty segment suffix.

Declaration

protected CompressingCodec(CompressionMode compressionMode, int chunkSize)

Parameters

Type	Name	Description
CompressionMode	compressionMode
int	chunkSize

CompressingCodec(string, CompressionMode, int)

Creates a compressing codec with a given segmentSuffix.

Declaration

protected CompressingCodec(string segmentSuffix, CompressionMode compressionMode, int chunkSize)

Parameters

Type	Name	Description
string	segmentSuffix
CompressionMode	compressionMode
int	chunkSize

Properties

StoredFieldsFormat

Encodes/decodes stored fields.

Declaration

public override StoredFieldsFormat StoredFieldsFormat { get; }

Property Value

Type	Description
StoredFieldsFormat

Overrides

Lucene.Net.Codecs.FilterCodec.StoredFieldsFormat

TermVectorsFormat

Encodes/decodes term vectors.

Declaration

public override TermVectorsFormat TermVectorsFormat { get; }

Property Value

Type	Description
TermVectorsFormat

Overrides

Lucene.Net.Codecs.FilterCodec.TermVectorsFormat

Methods

RandomInstance(Random)

Creates a random CompressingCodec that is using an empty segment suffix.

Declaration

public static CompressingCodec RandomInstance(Random random)

Parameters

Type	Name	Description
Random	random

Returns

Type	Description
CompressingCodec

RandomInstance(Random, bool)

Creates a random CompressingCodec that is using a segment suffix.

Declaration

public static CompressingCodec RandomInstance(Random random, bool withSegmentSuffix)

Parameters

Type	Name	Description
Random	random
bool	withSegmentSuffix

Returns

Type	Description
CompressingCodec

RandomInstance(Random, int, bool)

Create a random instance.

Declaration

public static CompressingCodec RandomInstance(Random random, int chunkSize, bool withSegmentSuffix)

Parameters

Type	Name	Description
Random	random
int	chunkSize
bool	withSegmentSuffix

Returns

Type	Description
CompressingCodec

ToString()

Returns the codec's name. Subclasses can override to provide more detail (such as parameters).

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

Lucene.Net.Codecs.Codec.ToString()