Lucene.Net.Analysis.CharStream Class Reference

CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharStream instead of System.IO.TextReader as input, which enables arbitrary character based filtering before tokenization. The CorrectOffset method fixed offsets to account for removal or insertion of characters, so that the offsets reported in the tokens match the character offsets of the original Reader. More...

Inherits StreamReader.

Inherited by Lucene.Net.Analysis.CharFilter, and Lucene.Net.Analysis.CharReader.

Public Member Functions
abstract int	CorrectOffset (int currentOff)
	Called by CharFilter(s) and Tokenizer to correct token offset.

Protected Member Functions
	CharStream (System.IO.StreamReader reader)

Detailed Description

CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharStream instead of System.IO.TextReader as input, which enables arbitrary character based filtering before tokenization. The CorrectOffset method fixed offsets to account for removal or insertion of characters, so that the offsets reported in the tokens match the character offsets of the original Reader.

Definition at line 30 of file CharStream.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.CharStream.CharStream ( System.IO.StreamReader  reader )

protected

Definition at line 32 of file CharStream.cs.

Member Function Documentation

abstract int Lucene.Net.Analysis.CharStream.CorrectOffset ( int  currentOff )

pure virtual

Called by CharFilter(s) and Tokenizer to correct token offset.

Parameters

currentOff

offset as seen in the output

Returns

corrected offset based on the input

Implemented in Lucene.Net.Analysis.CharFilter, and Lucene.Net.Analysis.CharReader.

---

The documentation for this class was generated from the following file:

• core/Analysis/CharStream.cs