Class CharFilter

Subclasses of CharFilter can be chained to filter a They can be used as with additional offset correction. Tokenizers will automatically use CorrectOffset(Int32) if a CharFilter subclass is used.

This class is abstract: at a minimum you must implement , transforming the input in some way from m_input, and Correct(Int32) to adjust the offsets to match the originals.

You can optionally provide more efficient implementations of additional methods like , but this is not required.

For examples and integration with Analyzer, see the Lucene.Net.Analysis namespace documentation.

Inheritance
System.Object
CharFilter
BaseCharFilter
PersianCharFilter
JapaneseIterationMarkCharFilter
Assembly: DistributedLucene.Net.dll
Syntax
public abstract class CharFilter : TextReader

Constructors

Name Description
CharFilter(TextReader)

Create a new CharFilter wrapping the provided reader.

Fields

Name Description
m_input

The underlying character-input stream.

Properties

Name Description
IsMarkSupported

Tells whether this stream supports the Mark(Int32) operation. The default implementation always returns false. Subclasses should override this method.

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

Tells whether this stream is ready to be read.

True if the next is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

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

Methods

Name Description
Correct(Int32)

Subclasses override to correct the current offset.
CorrectOffset(Int32)

Chains the corrected offset through the input CharFilter(s).
Dispose(Boolean)

Closes the underlying input stream.

NOTE: The default implementation closes the input , so be sure to call base.Dispose(disposing) when overriding this method.
Mark(Int32)

Marks the present position in the stream. Subsequent calls to Reset() will attempt to reposition the stream to this point. Not all character-input streams support the Mark(Int32) operation.

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

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

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.

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

Extension Methods