blob: 7b417e462d29d286b9ad77a37ec6630b860bd263 [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.TermDocEnumerator.TermDocUsingTermsEnumerator 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_term_doc_enumerator.html">TermDocEnumerator</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html">TermDocUsingTermsEnumerator</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_term_doc_enumerator_1_1_term_doc_using_terms_enumerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.TermDocEnumerator.TermDocUsingTermsEnumerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class to handle enumeration over the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating &lt;document, frequency&gt; pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a> that does NOT close them on a call to Dispose!
<a href="class_lucene_1_1_net_1_1_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#details">More...</a></p>
<p>Inherits IEnumerable&lt; int &gt;, and IEnumerator&lt; int &gt;.</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:a1e52317d72132f3e83a111fd175f0d23"><td class="memItemLeft" align="right" valign="top">IEnumerator&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#a1e52317d72132f3e83a111fd175f0d23">GetEnumerator</a> ()</td></tr>
<tr class="memdesc:a1e52317d72132f3e83a111fd175f0d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the enumerator. <a href="#a1e52317d72132f3e83a111fd175f0d23"></a><br/></td></tr>
<tr class="separator:a1e52317d72132f3e83a111fd175f0d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af82ea26d77a86b6101d3a6b4c11d372c"><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_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#af82ea26d77a86b6101d3a6b4c11d372c">Dispose</a> ()</td></tr>
<tr class="memdesc:af82ea26d77a86b6101d3a6b4c11d372c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispose impl. <a href="#af82ea26d77a86b6101d3a6b4c11d372c"></a><br/></td></tr>
<tr class="separator:af82ea26d77a86b6101d3a6b4c11d372c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dac7df75bba50a40a84cde1cbc47402"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#a4dac7df75bba50a40a84cde1cbc47402">MoveNext</a> ()</td></tr>
<tr class="memdesc:a4dac7df75bba50a40a84cde1cbc47402"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move to the next item. <a href="#a4dac7df75bba50a40a84cde1cbc47402"></a><br/></td></tr>
<tr class="separator:a4dac7df75bba50a40a84cde1cbc47402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8e1e2a014b9577d1277fe90855044d"><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_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#a8e8e1e2a014b9577d1277fe90855044d">Reset</a> ()</td></tr>
<tr class="memdesc:a8e8e1e2a014b9577d1277fe90855044d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not implemented. Use Seek instead. <a href="#a8e8e1e2a014b9577d1277fe90855044d"></a><br/></td></tr>
<tr class="separator:a8e8e1e2a014b9577d1277fe90855044d"><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:af9b42444b4864e3dfc143ae195b45ab1"><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_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html#af9b42444b4864e3dfc143ae195b45ab1">Current</a><code> [get]</code></td></tr>
<tr class="memdesc:af9b42444b4864e3dfc143ae195b45ab1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current document id. <a href="#af9b42444b4864e3dfc143ae195b45ab1"></a><br/></td></tr>
<tr class="separator:af9b42444b4864e3dfc143ae195b45ab1"><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>Class to handle enumeration over the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating &lt;document, frequency&gt; pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a> that does NOT close them on a call to Dispose! </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00392">392</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af82ea26d77a86b6101d3a6b4c11d372c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.TermDocEnumerator.TermDocUsingTermsEnumerator.Dispose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dispose impl. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00476">476</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a1e52317d72132f3e83a111fd175f0d23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerator&lt;int&gt; Lucene.Net.Index.TermDocEnumerator.TermDocUsingTermsEnumerator.GetEnumerator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the enumerator. </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00439">439</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4dac7df75bba50a40a84cde1cbc47402"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Index.TermDocEnumerator.TermDocUsingTermsEnumerator.MoveNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Move to the next item. </p>
<dl class="section return"><dt>Returns</dt><dd>True if more, false if not.</dd></dl>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00498">498</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a8e8e1e2a014b9577d1277fe90855044d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.TermDocEnumerator.TermDocUsingTermsEnumerator.Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Not implemented. Use Seek instead. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00506">506</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="af9b42444b4864e3dfc143ae195b45ab1"></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.TermDocEnumerator.TermDocUsingTermsEnumerator.Current</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>The current document id. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00465">465</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Core/Index/<a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.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>