| <!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.CharFilter 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 .NET port of the Java Lucene Indexing Library</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><a href="namespaces.html"><span>Packages</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></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="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html">CharFilter</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="class_lucene_1_1_net_1_1_analysis_1_1_char_filter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Analysis.CharFilter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Subclasses of <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a> can be chained to filter <a class="el" href="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>. They can be used as System.IO.TextReader with additional offset correction. <a class="el" href="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>s will automatically use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a3af22962a9d940595eb9cf4ed46e2991" title="Chains the corrected offset through the input CharFilter. ">CorrectOffset</a> if a CharFilter/CharStream subclass is used. |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html">Lucene.Net.Analysis.CharStream</a>.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter.html">Lucene.Net.Analysis.BaseCharFilter</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:a3af22962a9d940595eb9cf4ed46e2991"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a3af22962a9d940595eb9cf4ed46e2991">CorrectOffset</a> (int currentOff)</td></tr> |
| <tr class="memdesc:a3af22962a9d940595eb9cf4ed46e2991"><td class="mdescLeft"> </td><td class="mdescRight">Chains the corrected offset through the input <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a>. <a href="#a3af22962a9d940595eb9cf4ed46e2991"></a><br/></td></tr> |
| <tr class="separator:a3af22962a9d940595eb9cf4ed46e2991"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a376e96957bfab8393001b37a5b1cb020"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a376e96957bfab8393001b37a5b1cb020">Read</a> (System.Char[] cbuf, int off, int len)</td></tr> |
| <tr class="separator:a376e96957bfab8393001b37a5b1cb020"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ab90efdd434ee1f78f508e1f4148cd8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a2ab90efdd434ee1f78f508e1f4148cd8">MarkSupported</a> ()</td></tr> |
| <tr class="separator:a2ab90efdd434ee1f78f508e1f4148cd8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71c39e14b3b674b8230e2f861292da0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a71c39e14b3b674b8230e2f861292da0b">Mark</a> (int readAheadLimit)</td></tr> |
| <tr class="separator:a71c39e14b3b674b8230e2f861292da0b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad43279daec8b2c210f10ef040ca5a81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#aad43279daec8b2c210f10ef040ca5a81">Reset</a> ()</td></tr> |
| <tr class="separator:aad43279daec8b2c210f10ef040ca5a81"><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:ac6c59ce8a86e333eb377ef990306e2c7"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#ac6c59ce8a86e333eb377ef990306e2c7">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:ac6c59ce8a86e333eb377ef990306e2c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_char_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_char_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html">Lucene.Net.Analysis.CharStream</a></td></tr> |
| <tr class="memitem:a812d086f474e6587655951b199602a1b inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_char_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="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 inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Subclasses of <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a> can be chained to filter <a class="el" href="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>. They can be used as System.IO.TextReader with additional offset correction. <a class="el" href="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>s will automatically use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html#a3af22962a9d940595eb9cf4ed46e2991" title="Chains the corrected offset through the input CharFilter. ">CorrectOffset</a> if a CharFilter/CharStream subclass is used. </p> |
| <p><version> $Id$</p> |
| <p></version> </p> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00030">30</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a3af22962a9d940595eb9cf4ed46e2991"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Analysis.CharFilter.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Chains the corrected offset through the input <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html#aebdf487a8ce758f5539026a85cd5903d">Lucene.Net.Analysis.CharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00052">52</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac6c59ce8a86e333eb377ef990306e2c7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Lucene.Net.Analysis.CharFilter.Dispose </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>disposing</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="_char_filter_8cs_source.html#l00057">57</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a71c39e14b3b674b8230e2f861292da0b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Analysis.CharFilter.Mark </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>readAheadLimit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00084">84</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2ab90efdd434ee1f78f508e1f4148cd8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Analysis.CharFilter.MarkSupported </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00079">79</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a376e96957bfab8393001b37a5b1cb020"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Analysis.CharFilter.Read </td> |
| <td>(</td> |
| <td class="paramtype">System.Char[] </td> |
| <td class="paramname"><em>cbuf</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>off</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>len</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00074">74</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aad43279daec8b2c210f10ef040ca5a81"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Analysis.CharFilter.Reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_char_filter_8cs_source.html#l00090">90</a> of file <a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Analysis/<a class="el" href="_char_filter_8cs_source.html">CharFilter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:47 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> |
