Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html
blob: f552585ead08df0faa8076d14745915055ad4e52 [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.Index.FieldInvertState 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_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html">FieldInvertState</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_index_1_1_field_invert_state-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.FieldInvertState Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field.
<a href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#details">More...</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:afd1af918377340a92893e3e69cf0b437"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#afd1af918377340a92893e3e69cf0b437">FieldInvertState</a> ()</td></tr>
<tr class="separator:afd1af918377340a92893e3e69cf0b437"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a981f1c1112fcaa7f4edb36f243856ff6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#a981f1c1112fcaa7f4edb36f243856ff6">FieldInvertState</a> (int position, int length, int numOverlap, int offset, float boost)</td></tr>
<tr class="separator:a981f1c1112fcaa7f4edb36f243856ff6"><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:aad99b2e95223fd7486c143b527397b31"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#aad99b2e95223fd7486c143b527397b31">Position</a><code> [get]</code></td></tr>
<tr class="memdesc:aad99b2e95223fd7486c143b527397b31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the last processed term position. <a href="#aad99b2e95223fd7486c143b527397b31"></a><br/></td></tr>
<tr class="separator:aad99b2e95223fd7486c143b527397b31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab142700d134e5608a5b67f1aa5296a4a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#ab142700d134e5608a5b67f1aa5296a4a">Length</a><code> [get]</code></td></tr>
<tr class="memdesc:ab142700d134e5608a5b67f1aa5296a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get total number of terms in this field. <a href="#ab142700d134e5608a5b67f1aa5296a4a"></a><br/></td></tr>
<tr class="separator:ab142700d134e5608a5b67f1aa5296a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c55ca4aa4062f8301ccdb50d73eefd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#ab9c55ca4aa4062f8301ccdb50d73eefd">NumOverlap</a><code> [get]</code></td></tr>
<tr class="memdesc:ab9c55ca4aa4062f8301ccdb50d73eefd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of terms with <code>positionIncrement == 0</code>. <a href="#ab9c55ca4aa4062f8301ccdb50d73eefd"></a><br/></td></tr>
<tr class="separator:ab9c55ca4aa4062f8301ccdb50d73eefd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a051dd6122f3a54a635135bc6df035884"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#a051dd6122f3a54a635135bc6df035884">Offset</a><code> [get]</code></td></tr>
<tr class="memdesc:a051dd6122f3a54a635135bc6df035884"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get end offset of the last processed term. <a href="#a051dd6122f3a54a635135bc6df035884"></a><br/></td></tr>
<tr class="separator:a051dd6122f3a54a635135bc6df035884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf9103fd1634ea4450527f5fcd7d6a9d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#adf9103fd1634ea4450527f5fcd7d6a9d">Boost</a><code> [get]</code></td></tr>
<tr class="memdesc:adf9103fd1634ea4450527f5fcd7d6a9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name. <a href="#adf9103fd1634ea4450527f5fcd7d6a9d"></a><br/></td></tr>
<tr class="separator:adf9103fd1634ea4450527f5fcd7d6a9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b939a241b4e4f82aeaeeacd2cc64558"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_char_tokenizer_8cs.html#aed60c4e663aea1a7dec59cf4c3710058">AttributeSource</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_invert_state.html#a6b939a241b4e4f82aeaeeacd2cc64558">AttributeSource</a><code> [get]</code></td></tr>
<tr class="separator:a6b939a241b4e4f82aeaeeacd2cc64558"><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>This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field. </p>
<p><b>WARNING</b>: This API is new and experimental, and may suddenly change.</p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00032">32</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afd1af918377340a92893e3e69cf0b437"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.FieldInvertState.FieldInvertState </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="_field_invert_state_8cs_source.html#l00041">41</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a981f1c1112fcaa7f4edb36f243856ff6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.FieldInvertState.FieldInvertState </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>numOverlap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>boost</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="_field_invert_state_8cs_source.html#l00045">45</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a6b939a241b4e4f82aeaeeacd2cc64558"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_char_tokenizer_8cs.html#aed60c4e663aea1a7dec59cf4c3710058">AttributeSource</a> Lucene.Net.Index.FieldInvertState.AttributeSource</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00106">106</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="adf9103fd1634ea4450527f5fcd7d6a9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Index.FieldInvertState.Boost</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name. </p>
<p>the boost </p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00101">101</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab142700d134e5608a5b67f1aa5296a4a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.FieldInvertState.Length</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get total number of terms in this field.</p>
<p>the length </p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00077">77</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab9c55ca4aa4062f8301ccdb50d73eefd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.FieldInvertState.NumOverlap</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of terms with <code>positionIncrement == 0</code>.</p>
<p>the numOverlap </p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00084">84</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a051dd6122f3a54a635135bc6df035884"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.FieldInvertState.Offset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get end offset of the last processed term.</p>
<p>the offset </p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00091">91</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aad99b2e95223fd7486c143b527397b31"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.FieldInvertState.Position</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the last processed term position.</p>
<p>the position </p>
<p>Definition at line <a class="el" href="_field_invert_state_8cs_source.html#l00070">70</a> of file <a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Index/<a class="el" href="_field_invert_state_8cs_source.html">FieldInvertState.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:50 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>