| <!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.Analyzer 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_analyzer.html">Analyzer</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_analyzer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Analysis.Analyzer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html" title="An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...">Analyzer</a> builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. Typical implementations first build a <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>, which breaks the stream of characters from the Reader into raw Tokens. One or more TokenFilters may then be applied to the output of the <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>. |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#details">More...</a></p> |
| |
| <p>Inherits IDisposable.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_a_r_1_1_arabic_analyzer.html">Lucene.Net.Analysis.AR.ArabicAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_b_r_1_1_brazilian_analyzer.html">Lucene.Net.Analysis.BR.BrazilianAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_c_j_k_1_1_c_j_k_analyzer.html">Lucene.Net.Analysis.CJK.CJKAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_cn_1_1_chinese_analyzer.html">Lucene.Net.Analysis.Cn.ChineseAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_cz_1_1_czech_analyzer.html">Lucene.Net.Analysis.Cz.CzechAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_de_1_1_german_analyzer.html">Lucene.Net.Analysis.De.GermanAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_el_1_1_greek_analyzer.html">Lucene.Net.Analysis.El.GreekAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_ext_1_1_single_char_token_analyzer.html">Lucene.Net.Analysis.Ext.SingleCharTokenAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_ext_1_1_unaccented_word_analyzer.html">Lucene.Net.Analysis.Ext.UnaccentedWordAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_fa_1_1_persian_analyzer.html">Lucene.Net.Analysis.Fa.PersianAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_fr_1_1_french_analyzer.html">Lucene.Net.Analysis.Fr.FrenchAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_keyword_analyzer.html">Lucene.Net.Analysis.KeywordAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_miscellaneous_1_1_pattern_analyzer.html">Lucene.Net.Analysis.Miscellaneous.PatternAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_nl_1_1_dutch_analyzer.html">Lucene.Net.Analysis.Nl.DutchAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_per_field_analyzer_wrapper.html">Lucene.Net.Analysis.PerFieldAnalyzerWrapper</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_query_1_1_query_auto_stop_word_analyzer.html">Lucene.Net.Analysis.Query.QueryAutoStopWordAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_ru_1_1_russian_analyzer.html">Lucene.Net.Analysis.Ru.RussianAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_analyzer_wrapper.html">Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_simple_analyzer.html">Lucene.Net.Analysis.SimpleAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_snowball_1_1_snowball_analyzer.html">Lucene.Net.Analysis.Snowball.SnowballAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_standard_1_1_standard_analyzer.html">Lucene.Net.Analysis.Standard.StandardAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_stop_analyzer.html">Lucene.Net.Analysis.StopAnalyzer</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_th_1_1_thai_analyzer.html">Lucene.Net.Analysis.Th.ThaiAnalyzer</a>, and <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_whitespace_analyzer.html">Lucene.Net.Analysis.WhitespaceAnalyzer</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:ac031bae47f64e6bbe2117c991996f5fc"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#ac031bae47f64e6bbe2117c991996f5fc">TokenStream</a> (String fieldName, System.IO.TextReader reader)</td></tr> |
| <tr class="memdesc:ac031bae47f64e6bbe2117c991996f5fc"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility. <a href="#ac031bae47f64e6bbe2117c991996f5fc"></a><br/></td></tr> |
| <tr class="separator:ac031bae47f64e6bbe2117c991996f5fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38359e51b263c3a5dc8774651c35b8cd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a38359e51b263c3a5dc8774651c35b8cd">ReusableTokenStream</a> (String fieldName, System.IO.TextReader reader)</td></tr> |
| <tr class="memdesc:a38359e51b263c3a5dc8774651c35b8cd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> at the same time from this analyzer should use this method for better performance. <a href="#a38359e51b263c3a5dc8774651c35b8cd"></a><br/></td></tr> |
| <tr class="separator:a38359e51b263c3a5dc8774651c35b8cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace9d8916e2c0280b43369ffc119325c7"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#ace9d8916e2c0280b43369ffc119325c7">GetPositionIncrementGap</a> (String fieldName)</td></tr> |
| <tr class="memdesc:ace9d8916e2c0280b43369ffc119325c7"><td class="mdescLeft"> </td><td class="mdescRight">Invoked before indexing a Fieldable instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between Fieldable instances using the same field name. The default value position increment gap is 0. With a 0 position increment gap and the typical default token position increment of 1, all terms in a field, including across Fieldable instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across Fieldable instance boundaries. <a href="#ace9d8916e2c0280b43369ffc119325c7"></a><br/></td></tr> |
| <tr class="separator:ace9d8916e2c0280b43369ffc119325c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a333e181e02bf7f55a62f9a9dc828962e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a333e181e02bf7f55a62f9a9dc828962e">GetOffsetGap</a> (<a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> field)</td></tr> |
| <tr class="memdesc:a333e181e02bf7f55a62f9a9dc828962e"><td class="mdescLeft"> </td><td class="mdescRight">Just like <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#ace9d8916e2c0280b43369ffc119325c7" title="Invoked before indexing a Fieldable instance if terms have already been added to that field...">GetPositionIncrementGap</a>, except for <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Token</a> offsets instead. By default this returns 1 for tokenized fields and, as if the fields were joined with an extra space character, and 0 for un-tokenized fields. This method is only called if the field produced at least one token for indexing. <a href="#a333e181e02bf7f55a62f9a9dc828962e"></a><br/></td></tr> |
| <tr class="separator:a333e181e02bf7f55a62f9a9dc828962e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa1d893569bf85f78c973c1739386a0bb"><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_analyzer.html#aa1d893569bf85f78c973c1739386a0bb">Close</a> ()</td></tr> |
| <tr class="memdesc:aa1d893569bf85f78c973c1739386a0bb"><td class="mdescLeft"> </td><td class="mdescRight">Frees persistent resources used by this <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html" title="An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...">Analyzer</a> <a href="#aa1d893569bf85f78c973c1739386a0bb"></a><br/></td></tr> |
| <tr class="separator:aa1d893569bf85f78c973c1739386a0bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d1c1073953da2696e12cb66b82eaa8a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a5d1c1073953da2696e12cb66b82eaa8a">Dispose</a> ()</td></tr> |
| <tr class="separator:a5d1c1073953da2696e12cb66b82eaa8a"><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:acbe470079d1d35c819beb9820f72d536"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#acbe470079d1d35c819beb9820f72d536">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:acbe470079d1d35c819beb9820f72d536"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html" title="An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...">Analyzer</a> builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. </p> |
| <p>Typical implementations first build a <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>, which breaks the stream of characters from the Reader into raw Tokens. One or more TokenFilters may then be applied to the output of the <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>. </p> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00032">32</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aa1d893569bf85f78c973c1739386a0bb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Analysis.Analyzer.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees persistent resources used by this <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html" title="An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...">Analyzer</a> </p> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00146">146</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5d1c1073953da2696e12cb66b82eaa8a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Analysis.Analyzer.Dispose </td> |
| <td>(</td> |
| <td class="paramname"></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>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00151">151</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acbe470079d1d35c819beb9820f72d536"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Analysis.Analyzer.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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00156">156</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a333e181e02bf7f55a62f9a9dc828962e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int Lucene.Net.Analysis.Analyzer.GetOffsetGap </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> </td> |
| <td class="paramname"><em>field</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>Just like <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#ace9d8916e2c0280b43369ffc119325c7" title="Invoked before indexing a Fieldable instance if terms have already been added to that field...">GetPositionIncrementGap</a>, except for <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Token</a> offsets instead. By default this returns 1 for tokenized fields and, as if the fields were joined with an extra space character, and 0 for un-tokenized fields. This method is only called if the field produced at least one token for indexing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field</td><td>the field just indexed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>offset gap, added to the next token emitted from TokenStream(String,System.IO.TextReader) </dd></dl> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_per_field_analyzer_wrapper.html#ad8646950f0a7a8fdea4e9b53f7866acc">Lucene.Net.Analysis.PerFieldAnalyzerWrapper</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00140">140</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ace9d8916e2c0280b43369ffc119325c7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int Lucene.Net.Analysis.Analyzer.GetPositionIncrementGap </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>fieldName</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>Invoked before indexing a Fieldable instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between Fieldable instances using the same field name. The default value position increment gap is 0. With a 0 position increment gap and the typical default token position increment of 1, all terms in a field, including across Fieldable instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across Fieldable instance boundaries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td>Fieldable name being indexed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>position increment gap, added to the next token emitted from TokenStream(String,System.IO.TextReader) </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00123">123</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38359e51b263c3a5dc8774651c35b8cd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Analysis.Analyzer.ReusableTokenStream </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>reader</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Creates a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> at the same time from this analyzer should use this method for better performance. </p> |
| |
| <p>Definition at line <a class="el" href="_analyzer_8cs_source.html#l00047">47</a> of file <a class="el" href="_analyzer_8cs_source.html">Analyzer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac031bae47f64e6bbe2117c991996f5fc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Analysis.Analyzer.TokenStream </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>reader</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Creates a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Analysis/<a class="el" href="_analyzer_8cs_source.html">Analyzer.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> |
