Class BaseCharFilter

Base utility class for implementing a CharFilter. You subclass this, and then record mappings by calling AddOffCorrectMap(Int32, Int32), and then invoke the correct method to correct an offset.

Inheritance

System.Object

CharFilter

BaseCharFilter

HTMLStripCharFilter

MappingCharFilter

PatternReplaceCharFilter

BufferedCharFilter

Inherited Members

CharFilter.m_input

CharFilter.Dispose(Boolean)

CharFilter.CorrectOffset(Int32)

CharFilter.Read(Char[], Int32, Int32)

CharFilter.Read()

CharFilter.Skip(Int32)

CharFilter.Reset()

CharFilter.IsReady

CharFilter.IsMarkSupported

CharFilter.Mark(Int32)

Namespace: Lucene.Net.Analysis.CharFilters

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public abstract class BaseCharFilter : CharFilter

Constructors

BaseCharFilter(TextReader)

Declaration

public BaseCharFilter(TextReader in)

Parameters

Type	Name	Description
TextReader	in

Properties

LastCumulativeDiff

Declaration

protected virtual int LastCumulativeDiff { get; }

Property Value

Type	Description
System.Int32

Methods

AddOffCorrectMap(Int32, Int32)

Adds an offset correction mapping at the given output stream offset.

Assumption: the offset given with each successive call to this method will not be smaller than the offset given at the previous invocation.

Declaration

protected virtual void AddOffCorrectMap(int off, int cumulativeDiff)

Parameters

Type	Name	Description
System.Int32	off	The output stream offset at which to apply the correction
System.Int32	cumulativeDiff	The input offset is given by adding this to the output offset

Correct(Int32)

Retrieve the corrected offset.

Declaration

protected override int Correct(int currentOff)

Parameters

Type	Name	Description
System.Int32	currentOff

Returns

Type	Description
System.Int32