| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Analysis.CharStream Class Reference</title> |
| <link href="../../tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="../../jquery.js"></script> |
| <script type="text/javascript" src="../../dynsections.js"></script> |
| <link href="../../search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="../../search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="../../lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "../../search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="../../index.html"><span>Main Page</span></a></li> |
| <li class="current"><a href="../../annotated.html"><span>Classes</span></a></li> |
| <li><a href="../../files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="../../search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="../../annotated.html"><span>Class List</span></a></li> |
| <li><a href="../../classes.html"><span>Class Index</span></a></li> |
| <li><a href="../../hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="../../functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="../../df/d7a/namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="../../d3/dd0/namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="../../dd/de5/namespace_lucene_1_1_net_1_1_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html">CharStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="../../dd/d29/class_lucene_1_1_net_1_1_analysis_1_1_char_stream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Analysis.CharStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a> adds <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d" title="Called by CharFilter(s) and Tokenizer to correct token offset.">CorrectOffset</a> functionality over System.IO.TextReader. All Tokenizers accept a <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a> instead of System.IO.TextReader as input, which enables arbitrary character based filtering before tokenization. The <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d" title="Called by CharFilter(s) and Tokenizer to correct token offset.">CorrectOffset</a> 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. |
| <a href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#details">More...</a></p> |
| |
| <p>Inherits StreamReader.</p> |
| |
| <p>Inherited by <a class="el" href="../../dd/df7/class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html">Lucene.Net.Analysis.CharFilter</a>, and <a class="el" href="../../d0/d1f/class_lucene_1_1_net_1_1_analysis_1_1_char_reader.html">Lucene.Net.Analysis.CharReader</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:aebdf487a8ce758f5539026a85cd5903d"><td class="memItemLeft" align="right" valign="top">abstract int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d">CorrectOffset</a> (int currentOff)</td></tr> |
| <tr class="memdesc:aebdf487a8ce758f5539026a85cd5903d"><td class="mdescLeft"> </td><td class="mdescRight">Called by CharFilter(s) and <a class="el" href="../../d8/d6b/class_lucene_1_1_net_1_1_analysis_1_1_tokenizer.html" title="A Tokenizer is a TokenStream whose input is a Reader. This is an abstract class; subclasses must over...">Tokenizer</a> to correct token offset. <a href="#aebdf487a8ce758f5539026a85cd5903d"></a><br/></td></tr> |
| <tr class="separator:aebdf487a8ce758f5539026a85cd5903d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a812d086f474e6587655951b199602a1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#a812d086f474e6587655951b199602a1b">CharStream</a> (System.IO.StreamReader reader)</td></tr> |
| <tr class="separator:a812d086f474e6587655951b199602a1b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a> adds <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d" title="Called by CharFilter(s) and Tokenizer to correct token offset.">CorrectOffset</a> functionality over System.IO.TextReader. All Tokenizers accept a <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a> instead of System.IO.TextReader as input, which enables arbitrary character based filtering before tokenization. The <a class="el" href="../../d0/d88/class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d" title="Called by CharFilter(s) and Tokenizer to correct token offset.">CorrectOffset</a> 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. </p> |
| |
| <p>Definition at line <a class="el" href="../../dc/d1b/_analysis_2_char_stream_8cs_source.html#l00030">30</a> of file <a class="el" href="../../dc/d1b/_analysis_2_char_stream_8cs_source.html">CharStream.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a812d086f474e6587655951b199602a1b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.CharStream.CharStream </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.StreamReader </td> |
| <td class="paramname"><em>reader</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="../../dc/d1b/_analysis_2_char_stream_8cs_source.html#l00032">32</a> of file <a class="el" href="../../dc/d1b/_analysis_2_char_stream_8cs_source.html">CharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aebdf487a8ce758f5539026a85cd5903d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Lucene.Net.Analysis.CharStream.CorrectOffset </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>currentOff</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called by CharFilter(s) and <a class="el" href="../../d8/d6b/class_lucene_1_1_net_1_1_analysis_1_1_tokenizer.html" title="A Tokenizer is a TokenStream whose input is a Reader. This is an abstract class; subclasses must over...">Tokenizer</a> to correct token offset. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">currentOff</td><td>offset as seen in the output </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>corrected offset based on the input </dd></dl> |
| |
| <p>Implemented in <a class="el" href="../../dd/df7/class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a3af22962a9d940595eb9cf4ed46e2991">Lucene.Net.Analysis.CharFilter</a>, and <a class="el" href="../../d0/d1f/class_lucene_1_1_net_1_1_analysis_1_1_char_reader.html#aa1062e55b9e8d9c66792ebb1a7d2ccc9">Lucene.Net.Analysis.CharReader</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Analysis/<a class="el" href="../../dc/d1b/_analysis_2_char_stream_8cs_source.html">CharStream.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:34:15 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="../../doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |