| <!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.TermDocs Interface 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_index.html">Index</a></li><li class="navelem"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">TermDocs</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interface_lucene_1_1_net_1_1_index_1_1_term_docs-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.TermDocs Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating <document, frequency> 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> provides an interface for enumerating <document, frequency> pairs for a term. The document portion names each document containing the term. <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> 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. |
| <a href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#details">More...</a></p> |
| |
| <p>Inherits IDisposable.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html">Lucene.Net.Index.AbstractAllTermDocs</a>, Lucene.Net.Index.DirectoryReader.MultiTermDocs, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>, Lucene.Net.Index.ParallelReader.ParallelTermDocs, Lucene.Net.Index.SegmentTermDocs, and <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">Lucene.Net.Index.TermPositions</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:a63eba164c41e26450d60753cd548cbcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a63eba164c41e26450d60753cd548cbcb">Seek</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> term)</td></tr> |
| <tr class="memdesc:a63eba164c41e26450d60753cd548cbcb"><td class="mdescLeft"> </td><td class="mdescRight">Sets this to the data for a term. The enumeration is reset to the start of the data for this term. <a href="#a63eba164c41e26450d60753cd548cbcb"></a><br/></td></tr> |
| <tr class="separator:a63eba164c41e26450d60753cd548cbcb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3da74fa2092995ebe6e9bea544a2cd91"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a3da74fa2092995ebe6e9bea544a2cd91">Seek</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_enum.html">TermEnum</a> termEnum)</td></tr> |
| <tr class="memdesc:a3da74fa2092995ebe6e9bea544a2cd91"><td class="mdescLeft"> </td><td class="mdescRight">Sets this to the data for the current term in a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_enum.html" title="Abstract class for enumerating terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. ">TermEnum</a>. This may be optimized in some implementations. <a href="#a3da74fa2092995ebe6e9bea544a2cd91"></a><br/></td></tr> |
| <tr class="separator:a3da74fa2092995ebe6e9bea544a2cd91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a07b58ff92edf95aff4fbc264eb12e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7">Next</a> ()</td></tr> |
| <tr class="memdesc:a5a07b58ff92edf95aff4fbc264eb12e7"><td class="mdescLeft"> </td><td class="mdescRight">Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration. <a href="#a5a07b58ff92edf95aff4fbc264eb12e7"></a><br/></td></tr> |
| <tr class="separator:a5a07b58ff92edf95aff4fbc264eb12e7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a04438d982669143e564b4128e96dd6c9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a04438d982669143e564b4128e96dd6c9">Read</a> (int[] docs, int[] freqs)</td></tr> |
| <tr class="memdesc:a04438d982669143e564b4128e96dd6c9"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to read multiple entries from the enumeration, up to length of <em>docs</em>. Document numbers are stored in <em>docs</em>, and term frequencies are stored in <em>freqs</em>. The <em>freqs</em> array must be as long as the <em>docs</em> array. <a href="#a04438d982669143e564b4128e96dd6c9"></a><br/></td></tr> |
| <tr class="separator:a04438d982669143e564b4128e96dd6c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a860fa309506967c3206a28f470cde29e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a860fa309506967c3206a28f470cde29e">SkipTo</a> (int target)</td></tr> |
| <tr class="memdesc:a860fa309506967c3206a28f470cde29e"><td class="mdescLeft"> </td><td class="mdescRight">Skips entries to the first beyond the current whose document number is greater than or equal to <em>target</em>. Returns true iff there is such an entry. Behaves as if written: <a href="#a860fa309506967c3206a28f470cde29e"></a><br/></td></tr> |
| <tr class="separator:a860fa309506967c3206a28f470cde29e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9cc49d963030dda58f218ca274430dbb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a9cc49d963030dda58f218ca274430dbb">Close</a> ()</td></tr> |
| <tr class="memdesc:a9cc49d963030dda58f218ca274430dbb"><td class="mdescLeft"> </td><td class="mdescRight">Frees associated resources. <a href="#a9cc49d963030dda58f218ca274430dbb"></a><br/></td></tr> |
| <tr class="separator:a9cc49d963030dda58f218ca274430dbb"><td class="memSeparator" colspan="2"> </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:af4d11271571bff528c0639eb69cd8b4d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#af4d11271571bff528c0639eb69cd8b4d">Doc</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af4d11271571bff528c0639eb69cd8b4d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current document number. This is invalid until <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7" title="Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumerat...">Next()</a> is called for the first time. <a href="#af4d11271571bff528c0639eb69cd8b4d"></a><br/></td></tr> |
| <tr class="separator:af4d11271571bff528c0639eb69cd8b4d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9518490703cce46b57cf9f931b6edd7c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a9518490703cce46b57cf9f931b6edd7c">Freq</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9518490703cce46b57cf9f931b6edd7c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the frequency of the term within the current document. This is invalid until <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7" title="Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumerat...">Next()</a> is called for the first time. <a href="#a9518490703cce46b57cf9f931b6edd7c"></a><br/></td></tr> |
| <tr class="separator:a9518490703cce46b57cf9f931b6edd7c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating <document, frequency> 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> provides an interface for enumerating <document, frequency> pairs for a term. </p> |
| <p>The document portion names each document containing the term. <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> are indicated by number. The frequency portion gives the number of times the term occurred in each document. </p> |
| <p>The pairs are ordered by document number. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#a1135d529c2f501ae0eb6ee191ab3bea4" title="Returns an unpositioned Lucene.Net.Index.TermDocs enumerator.">IndexReader.TermDocs()</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_term_docs_8cs_source.html#l00029">29</a> of file <a class="el" href="_term_docs_8cs_source.html">TermDocs.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a9cc49d963030dda58f218ca274430dbb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.TermDocs.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees associated resources. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a5088bec9145900a5aa93108df1d533e1">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a7c7bd6f0496d02b833fdd543d29900b2">Lucene.Net.Index.AbstractAllTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#a0bc7051fe6b1f12feafdd94083c9193b">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5a07b58ff92edf95aff4fbc264eb12e7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.TermDocs.Next </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#ad3f5c6fcd956f980603663a39ebc5abf">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a3fc18c95fdbb653a29f2b8adaed8270d">Lucene.Net.Index.AbstractAllTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#a8ee64285677dfcae65bbecddb50a0745">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a04438d982669143e564b4128e96dd6c9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.TermDocs.Read </td> |
| <td>(</td> |
| <td class="paramtype">int[] </td> |
| <td class="paramname"><em>docs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int[] </td> |
| <td class="paramname"><em>freqs</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Attempts to read multiple entries from the enumeration, up to length of <em>docs</em>. Document numbers are stored in <em>docs</em>, and term frequencies are stored in <em>freqs</em>. The <em>freqs</em> array must be as long as the <em>docs</em> array. </p> |
| <p>Returns the number of entries read. Zero is only returned when the stream has been exhausted. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a4b4ac5d706c5e00d8645409d21c13089">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#ab5f92c641927b32867a7e42982042f67">Lucene.Net.Index.AbstractAllTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#a130ad2b0c7ad8703e4322badf925761e">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a63eba164c41e26450d60753cd548cbcb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.TermDocs.Seek </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> </td> |
| <td class="paramname"><em>term</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets this to the data for a term. The enumeration is reset to the start of the data for this term. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#ad9fbc7a04ffad45f4e78ee00f2fb06f0">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#ac65f4a87cda1d5b38a727fe9d3b732b5">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a071261b53fc25e98b4dbdb19f53fc6ce">Lucene.Net.Index.AbstractAllTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3da74fa2092995ebe6e9bea544a2cd91"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.TermDocs.Seek </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_enum.html">TermEnum</a> </td> |
| <td class="paramname"><em>termEnum</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets this to the data for the current term in a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_enum.html" title="Abstract class for enumerating terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. ">TermEnum</a>. This may be optimized in some implementations. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#ac401403f9dc9aa5d27ac00eff46f1016">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#adc0d97cbc3f9ce346ad30498e62d9c28">Lucene.Net.Index.AbstractAllTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#ae435894514bde8cd52082c30fef376de">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a860fa309506967c3206a28f470cde29e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.TermDocs.SkipTo </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>target</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Skips entries to the first beyond the current whose document number is greater than or equal to <em>target</em>. Returns true iff there is such an entry. Behaves as if written: </p> |
| <p><code> boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; } </code> Some implementations are considerably more efficient than that. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#add7f1c250506dc1a0d9c40097a882cb9">Lucene.Net.Index.MultipleTermPositions</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a6f5c207aa014ff16b99a8894798ad1ef">Lucene.Net.Index.AbstractAllTermDocs</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs.html#a67caa260b0a17380dda92d07c4282027">Lucene.Net.Index.FilterIndexReader.FilterTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="af4d11271571bff528c0639eb69cd8b4d"></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.TermDocs.Doc</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>Returns the current document number. This is invalid until <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7" title="Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumerat...">Next()</a> is called for the first time. </p> |
| |
| <p>Definition at line <a class="el" href="_term_docs_8cs_source.html#l00044">44</a> of file <a class="el" href="_term_docs_8cs_source.html">TermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9518490703cce46b57cf9f931b6edd7c"></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.TermDocs.Freq</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>Returns the frequency of the term within the current document. This is invalid until <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7" title="Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumerat...">Next()</a> is called for the first time. </p> |
| |
| <p>Definition at line <a class="el" href="_term_docs_8cs_source.html#l00049">49</a> of file <a class="el" href="_term_docs_8cs_source.html">TermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_term_docs_8cs_source.html">TermDocs.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:55 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> |
