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
System.IO.TextReader
CharFilter
BaseCharFilter
HTMLStripCharFilter
MappingCharFilter
PatternReplaceCharFilter
BufferedCharFilter
Implements
System.IDisposable
Inherited Members
System.IO.TextReader.Null
System.IO.TextReader.Dispose()
System.IO.TextReader.Peek()
System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)
System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)
System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)
System.IO.TextReader.ReadLine()
System.IO.TextReader.ReadLineAsync()
System.IO.TextReader.ReadToEnd()
System.IO.TextReader.ReadToEndAsync()
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.Analysis.CharFilters
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public abstract class BaseCharFilter : CharFilter, IDisposable

Constructors

| Improve this Doc View Source

BaseCharFilter(TextReader)

Declaration
public BaseCharFilter(TextReader in)
Parameters
Type Name Description
System.IO.TextReader in

Properties

| Improve this Doc View Source

LastCumulativeDiff

Declaration
protected virtual int LastCumulativeDiff { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

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

| Improve this Doc View Source

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
Overrides

Implements

System.IDisposable