Class MappingCharFilter

Simplistic Lucene.Net.Analysis.CharFilter that applies the mappings contained in a NormalizeCharMap to the character stream, and correcting the resulting changes to the offsets. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string.

Inheritance

object

MarshalByRefObject

TextReader

CharFilter

BaseCharFilter

MappingCharFilter

Implements

IDisposable

Inherited Members

BaseCharFilter.Correct(int)

BaseCharFilter.LastCumulativeDiff

BaseCharFilter.AddOffCorrectMap(int, int)

CharFilter.m_input

CharFilter.Dispose(bool)

CharFilter.CorrectOffset(int)

CharFilter.Skip(int)

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 class MappingCharFilter : BaseCharFilter, IDisposable

Constructors

MappingCharFilter(NormalizeCharMap, TextReader)

Default constructor that takes a TextReader.

Declaration

public MappingCharFilter(NormalizeCharMap normMap, TextReader @in)

Parameters

Type	Name	Description
NormalizeCharMap	normMap
TextReader	in

Methods

Read()

Reads the next character from the text reader and advances the character position by one character.

Declaration

public override int Read()

Returns

Type	Description
int	The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.

Overrides

Lucene.Net.Analysis.CharFilter.Read()

Exceptions

Type	Condition
ObjectDisposedException	The TextReader is closed.
IOException	An I/O error occurs.

Read(char[], int, int)

Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

Declaration

public override int Read(char[] cbuf, int off, int len)

Parameters

Type	Name	Description
char[]	cbuf
int	off
int	len

Returns

Type	Description
int	The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

Overrides

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

Exceptions

Type	Condition
ArgumentNullException	buffer is null.
ArgumentException	The buffer length minus index is less than count.
ArgumentOutOfRangeException	index or count is negative.
ObjectDisposedException	The TextReader is closed.
IOException	An I/O error occurs.

Reset()

LUCENENET specific. Moved here from the Reader class (in Java) so it can be overridden to provide reader buffering.

Declaration

public override void Reset()

Overrides

Lucene.Net.Analysis.CharFilter.Reset()

Implements

IDisposable