Show / Hide Table of Contents

    Class FilterCodec

    A codec that forwards all its method calls to another codec.

    Extend this class when you need to reuse the functionality of an existing codec. For example, if you want to build a codec that redefines Lucene46's LiveDocsFormat:

        public sealed class CustomCodec : FilterCodec 
        {
            public CustomCodec()
                : base("CustomCodec", new Lucene46Codec())
            {
            }
    
            public override LiveDocsFormat LiveDocsFormat 
            {
                get { return new CustomLiveDocsFormat(); }
            }
        }

    Please note: Don't call ForName(String) from the no-arg constructor of your own codec. When the DefaultCodecFactory loads your own Codec, the DefaultCodecFactory has not yet fully initialized! If you want to extend another Codec, instantiate it directly by calling its constructor.

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    Codec
    FilterCodec
    Inherited Members
    Codec.SetCodecFactory(ICodecFactory)
    Codec.GetCodecFactory()
    Codec.Name
    Codec.ForName(String)
    Codec.AvailableCodecs
    Codec.Default
    Codec.ToString()
    Namespace: Lucene.Net.Codecs
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class FilterCodec : Codec

    Constructors

    | Improve this Doc View Source

    FilterCodec(Codec)

    Sole constructor. When subclassing this codec, create a no-arg ctor and pass the delegate codec and a unique name to this ctor.

    Declaration
    protected FilterCodec(Codec delegate)
    Parameters
    Type Name Description
    Codec delegate

    Fields

    | Improve this Doc View Source

    m_delegate

    The codec to filter.

    Declaration
    protected readonly Codec m_delegate
    Field Value
    Type Description
    Codec

    Properties

    | Improve this Doc View Source

    DocValuesFormat

    Declaration
    public override DocValuesFormat DocValuesFormat { get; }
    Property Value
    Type Description
    DocValuesFormat
    Overrides
    Codec.DocValuesFormat
    | Improve this Doc View Source

    FieldInfosFormat

    Declaration
    public override FieldInfosFormat FieldInfosFormat { get; }
    Property Value
    Type Description
    FieldInfosFormat
    Overrides
    Codec.FieldInfosFormat
    | Improve this Doc View Source

    LiveDocsFormat

    Declaration
    public override LiveDocsFormat LiveDocsFormat { get; }
    Property Value
    Type Description
    LiveDocsFormat
    Overrides
    Codec.LiveDocsFormat
    | Improve this Doc View Source

    NormsFormat

    Declaration
    public override NormsFormat NormsFormat { get; }
    Property Value
    Type Description
    NormsFormat
    Overrides
    Codec.NormsFormat
    | Improve this Doc View Source

    PostingsFormat

    Declaration
    public override PostingsFormat PostingsFormat { get; }
    Property Value
    Type Description
    PostingsFormat
    Overrides
    Codec.PostingsFormat
    | Improve this Doc View Source

    SegmentInfoFormat

    Declaration
    public override SegmentInfoFormat SegmentInfoFormat { get; }
    Property Value
    Type Description
    SegmentInfoFormat
    Overrides
    Codec.SegmentInfoFormat
    | Improve this Doc View Source

    StoredFieldsFormat

    Declaration
    public override StoredFieldsFormat StoredFieldsFormat { get; }
    Property Value
    Type Description
    StoredFieldsFormat
    Overrides
    Codec.StoredFieldsFormat
    | Improve this Doc View Source

    TermVectorsFormat

    Declaration
    public override TermVectorsFormat TermVectorsFormat { get; }
    Property Value
    Type Description
    TermVectorsFormat
    Overrides
    Codec.TermVectorsFormat
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)