Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html
blob: 23a0f1bca4bc376c917db1a4239f8130c5f14e3a [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.Tokenattributes.PositionIncrementAttribute 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="namespace_lucene_1_1_net_1_1_analysis_1_1_tokenattributes.html">Tokenattributes</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html">PositionIncrementAttribute</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The positionIncrement determines the position of this token relative to the previous <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> in 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>, used in phrase searching.
<a href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#details">More...</a></p>
<p>Inherits Attribute, <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute.html">Lucene.Net.Analysis.Tokenattributes.IPositionIncrementAttribute</a>, and ICloneable.</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:afc04b3d64a630d20eec0dd3bbc8505b7"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#afc04b3d64a630d20eec0dd3bbc8505b7">Clear</a> ()</td></tr>
<tr class="separator:afc04b3d64a630d20eec0dd3bbc8505b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cb06b958e32bfe9ec57fc93fd2c7d3c"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#a8cb06b958e32bfe9ec57fc93fd2c7d3c">Equals</a> (System.Object other)</td></tr>
<tr class="separator:a8cb06b958e32bfe9ec57fc93fd2c7d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af18a846bb253fedb5867047642c4e673"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#af18a846bb253fedb5867047642c4e673">GetHashCode</a> ()</td></tr>
<tr class="separator:af18a846bb253fedb5867047642c4e673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f17a55231be2d005f278ff0c64ca74d"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#a9f17a55231be2d005f278ff0c64ca74d">CopyTo</a> (<a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a> target)</td></tr>
<tr class="separator:a9f17a55231be2d005f278ff0c64ca74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9df998093b813178888d08a83fbf2fd1"><td class="memItemLeft" align="right" valign="top">override System.Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_position_increment_attribute.html#a9df998093b813178888d08a83fbf2fd1">Clone</a> ()</td></tr>
<tr class="separator:a9df998093b813178888d08a83fbf2fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a84f797df04681637475aea5b35b4e6b1"><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_tokenattributes_1_1_position_increment_attribute.html#a84f797df04681637475aea5b35b4e6b1">PositionIncrement</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a84f797df04681637475aea5b35b4e6b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the position increment. The default value is one. <a href="#a84f797df04681637475aea5b35b4e6b1"></a><br/></td></tr>
<tr class="separator:a84f797df04681637475aea5b35b4e6b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute.html">Lucene.Net.Analysis.Tokenattributes.IPositionIncrementAttribute</a></td></tr>
<tr class="memitem:a3d8ab40f937085e6708296059d0732b2 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute.html#a3d8ab40f937085e6708296059d0732b2">PositionIncrement</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a3d8ab40f937085e6708296059d0732b2 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the position increment. The default value is one. <a href="#a3d8ab40f937085e6708296059d0732b2"></a><br/></td></tr>
<tr class="separator:a3d8ab40f937085e6708296059d0732b2 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_position_increment_attribute"><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>The positionIncrement determines the position of this token relative to the previous <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> in 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>, used in phrase searching. </p>
<p>The default value is one.</p>
<p>Some common uses for this are:</p>
<ul>
<li>
<p class="startli">Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.</p>
<p class="endli"></p>
</li>
</ul>
<p>Definition at line <a class="el" href="_position_increment_attribute_8cs_source.html#l00050">50</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afc04b3d64a630d20eec0dd3bbc8505b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Clear </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="_position_increment_attribute_8cs_source.html#l00069">69</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9df998093b813178888d08a83fbf2fd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.Object Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Clone </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="_position_increment_attribute_8cs_source.html#l00100">100</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9f17a55231be2d005f278ff0c64ca74d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.CopyTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_position_increment_attribute_8cs_source.html#l00094">94</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a8cb06b958e32bfe9ec57fc93fd2c7d3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Equals </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_position_increment_attribute_8cs_source.html#l00074">74</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af18a846bb253fedb5867047642c4e673"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.GetHashCode </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="_position_increment_attribute_8cs_source.html#l00089">89</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a84f797df04681637475aea5b35b4e6b1"></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.Tokenattributes.PositionIncrementAttribute.PositionIncrement</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the position increment. The default value is one. </p>
<p>the distance from the prior term </p>
<p>Definition at line <a class="el" href="_position_increment_attribute_8cs_source.html#l00059">59</a> of file <a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Analysis/Tokenattributes/<a class="el" href="_position_increment_attribute_8cs_source.html">PositionIncrementAttribute.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 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>