blob: b39e138d79b07b28b157ca66e4c65aef8d4d44a7 [file] [log] [blame]
<!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.SimpleAnalyzer 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_simple_analyzer.html">SimpleAnalyzer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_simple_analyzer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.SimpleAnalyzer Class Reference</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> that filters <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_letter_tokenizer.html" title="A LetterTokenizer is a tokenizer that divides text at non-letters. That&#39;s to say, it defines tokens a...">LetterTokenizer</a> with <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_lower_case_filter.html" title="Normalizes token text to lower case.">LowerCaseFilter</a>
<a href="class_lucene_1_1_net_1_1_analysis_1_1_simple_analyzer.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Lucene.Net.Analysis.Analyzer</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:a286f94a679e28c6ef0c15150ff7a0575"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_simple_analyzer.html#a286f94a679e28c6ef0c15150ff7a0575">TokenStream</a> (System.String fieldName, System.IO.TextReader reader)</td></tr>
<tr class="separator:a286f94a679e28c6ef0c15150ff7a0575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad65740750d7d8ab2ae8572e8ffc7e11a"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_simple_analyzer.html#ad65740750d7d8ab2ae8572e8ffc7e11a">ReusableTokenStream</a> (System.String fieldName, System.IO.TextReader reader)</td></tr>
<tr class="separator:ad65740750d7d8ab2ae8572e8ffc7e11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Lucene.Net.Analysis.Analyzer</a></td></tr>
<tr class="memitem:ac031bae47f64e6bbe2117c991996f5fc inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><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>&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38359e51b263c3a5dc8774651c35b8cd inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><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>&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace9d8916e2c0280b43369ffc119325c7 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a333e181e02bf7f55a62f9a9dc828962e inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="mdescLeft">&#160;</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&#39;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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d893569bf85f78c973c1739386a0bb inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memItemLeft" align="right" valign="top">void&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d1c1073953da2696e12cb66b82eaa8a inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Lucene.Net.Analysis.Analyzer</a></td></tr>
<tr class="memitem:acbe470079d1d35c819beb9820f72d536 inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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 inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_analyzer"><td class="memSeparator" colspan="2">&#160;</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> that filters <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_letter_tokenizer.html" title="A LetterTokenizer is a tokenizer that divides text at non-letters. That&#39;s to say, it defines tokens a...">LetterTokenizer</a> with <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_lower_case_filter.html" title="Normalizes token text to lower case.">LowerCaseFilter</a> </p>
<p>Definition at line <a class="el" href="_simple_analyzer_8cs_source.html#l00025">25</a> of file <a class="el" href="_simple_analyzer_8cs_source.html">SimpleAnalyzer.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad65740750d7d8ab2ae8572e8ffc7e11a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Analysis.SimpleAnalyzer.ReusableTokenStream </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fieldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.IO.TextReader&#160;</td>
<td class="paramname"><em>reader</em>&#160;</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="_simple_analyzer_8cs_source.html#l00032">32</a> of file <a class="el" href="_simple_analyzer_8cs_source.html">SimpleAnalyzer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a286f94a679e28c6ef0c15150ff7a0575"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Analysis.SimpleAnalyzer.TokenStream </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fieldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.IO.TextReader&#160;</td>
<td class="paramname"><em>reader</em>&#160;</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="_simple_analyzer_8cs_source.html#l00027">27</a> of file <a class="el" href="_simple_analyzer_8cs_source.html">SimpleAnalyzer.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="_simple_analyzer_8cs_source.html">SimpleAnalyzer.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:48 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>