Class BaseCharFilter

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

Inheritance

object

MarshalByRefObject

TextReader

CharFilter

BaseCharFilter

HTMLStripCharFilter

MappingCharFilter

PatternReplaceCharFilter

BufferedCharFilter

Implements

IDisposable

Inherited Members

CharFilter.m_input

CharFilter.Dispose(bool)

CharFilter.CorrectOffset(int)

CharFilter.Read(char[], int, int)

CharFilter.Read()

CharFilter.Skip(int)

CharFilter.Reset()

CharFilter.IsReady

CharFilter.IsMarkSupported

CharFilter.Mark(int)

TextReader.Null

TextReader.Close()

TextReader.Dispose()

TextReader.Peek()

TextReader.Read(Span<char>)

TextReader.ReadAsync(char[], int, int)

TextReader.ReadAsync(Memory<char>, CancellationToken)

TextReader.ReadBlock(char[], int, int)

TextReader.ReadBlock(Span<char>)

TextReader.ReadBlockAsync(char[], int, int)

TextReader.ReadBlockAsync(Memory<char>, CancellationToken)

TextReader.ReadLine()

TextReader.ReadLineAsync()

TextReader.ReadLineAsync(CancellationToken)

TextReader.ReadToEnd()

TextReader.ReadToEndAsync()

TextReader.ReadToEndAsync(CancellationToken)

TextReader.Synchronized(TextReader)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Analysis.CharFilters

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public abstract class BaseCharFilter : CharFilter, IDisposable

Constructors

BaseCharFilter(TextReader)

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

Declaration

protected BaseCharFilter(TextReader @in)

Parameters

Type	Name	Description
TextReader	in

Properties

LastCumulativeDiff

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

Declaration

protected virtual int LastCumulativeDiff { get; }

Property Value

Type	Description
int

Methods

AddOffCorrectMap(int, int)

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
int	off	The output stream offset at which to apply the correction
int	cumulativeDiff	The input offset is given by adding this to the output offset

Correct(int)

Retrieve the corrected offset.

Declaration

protected override int Correct(int currentOff)

Parameters

Type	Name	Description
int	currentOff

Returns

Type	Description
int

Overrides

CharFilter.Correct(int)

Implements

IDisposable