| <!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.AbstractAllTermDocs 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 |
|  <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="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html">AbstractAllTermDocs</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.AbstractAllTermDocs Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for enumerating all but deleted docs. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_all_term_docs.html">Lucene.Net.Index.AllTermDocs</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:a071261b53fc25e98b4dbdb19f53fc6ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a071261b53fc25e98b4dbdb19f53fc6ce">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:a071261b53fc25e98b4dbdb19f53fc6ce"><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="#a071261b53fc25e98b4dbdb19f53fc6ce"></a><br/></td></tr> |
| <tr class="separator:a071261b53fc25e98b4dbdb19f53fc6ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc0d97cbc3f9ce346ad30498e62d9c28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#adc0d97cbc3f9ce346ad30498e62d9c28">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:adc0d97cbc3f9ce346ad30498e62d9c28"><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="#adc0d97cbc3f9ce346ad30498e62d9c28"></a><br/></td></tr> |
| <tr class="separator:adc0d97cbc3f9ce346ad30498e62d9c28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fc18c95fdbb653a29f2b8adaed8270d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a3fc18c95fdbb653a29f2b8adaed8270d">Next</a> ()</td></tr> |
| <tr class="memdesc:a3fc18c95fdbb653a29f2b8adaed8270d"><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="#a3fc18c95fdbb653a29f2b8adaed8270d"></a><br/></td></tr> |
| <tr class="separator:a3fc18c95fdbb653a29f2b8adaed8270d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5f92c641927b32867a7e42982042f67"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#ab5f92c641927b32867a7e42982042f67">Read</a> (int[] docs, int[] freqs)</td></tr> |
| <tr class="memdesc:ab5f92c641927b32867a7e42982042f67"><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="#ab5f92c641927b32867a7e42982042f67"></a><br/></td></tr> |
| <tr class="separator:ab5f92c641927b32867a7e42982042f67"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f5c207aa014ff16b99a8894798ad1ef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a6f5c207aa014ff16b99a8894798ad1ef">SkipTo</a> (int target)</td></tr> |
| <tr class="memdesc:a6f5c207aa014ff16b99a8894798ad1ef"><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="#a6f5c207aa014ff16b99a8894798ad1ef"></a><br/></td></tr> |
| <tr class="separator:a6f5c207aa014ff16b99a8894798ad1ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c7bd6f0496d02b833fdd543d29900b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a7c7bd6f0496d02b833fdd543d29900b2">Close</a> ()</td></tr> |
| <tr class="memdesc:a7c7bd6f0496d02b833fdd543d29900b2"><td class="mdescLeft"> </td><td class="mdescRight">Frees associated resources. <a href="#a7c7bd6f0496d02b833fdd543d29900b2"></a><br/></td></tr> |
| <tr class="separator:a7c7bd6f0496d02b833fdd543d29900b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af79d55880da515fe511b13582e078f12"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#af79d55880da515fe511b13582e078f12">Dispose</a> ()</td></tr> |
| <tr class="separator:af79d55880da515fe511b13582e078f12"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4856145e5c7345d2e0c2413a90bb2b70"><td class="memItemLeft" align="right" valign="top">abstract bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a4856145e5c7345d2e0c2413a90bb2b70">IsDeleted</a> (int doc)</td></tr> |
| <tr class="separator:a4856145e5c7345d2e0c2413a90bb2b70"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:ac6beae8b7a9e54bfd3c5cdfb9726c8d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#ac6beae8b7a9e54bfd3c5cdfb9726c8d9">AbstractAllTermDocs</a> (int <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a7682ab16e0b5205ff7a2756cec975054">maxDoc</a>)</td></tr> |
| <tr class="separator:ac6beae8b7a9e54bfd3c5cdfb9726c8d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e13ac4bfff7fbcadced35b13e91dd0e"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a4e13ac4bfff7fbcadced35b13e91dd0e">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:a4e13ac4bfff7fbcadced35b13e91dd0e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a7682ab16e0b5205ff7a2756cec975054"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a7682ab16e0b5205ff7a2756cec975054">maxDoc</a></td></tr> |
| <tr class="separator:a7682ab16e0b5205ff7a2756cec975054"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6106b99c25cf3e83360e2f9dc7b4d98a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a6106b99c25cf3e83360e2f9dc7b4d98a">internalDoc</a> = -1</td></tr> |
| <tr class="separator:a6106b99c25cf3e83360e2f9dc7b4d98a"><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:ae0cc2fb30d68edbd83a1880d422c6f92"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#ae0cc2fb30d68edbd83a1880d422c6f92">Doc</a><code> [get]</code></td></tr> |
| <tr class="separator:ae0cc2fb30d68edbd83a1880d422c6f92"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b7e02bd1c6672e7f95d767d06aa4ffc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_abstract_all_term_docs.html#a3b7e02bd1c6672e7f95d767d06aa4ffc">Freq</a><code> [get]</code></td></tr> |
| <tr class="separator:a3b7e02bd1c6672e7f95d767d06aa4ffc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">Lucene.Net.Index.TermDocs</a></td></tr> |
| <tr class="memitem:af4d11271571bff528c0639eb69cd8b4d inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><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 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><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 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9518490703cce46b57cf9f931b6edd7c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><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 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><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 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base class for enumerating all but deleted docs. </p> |
| <p>NOTE: this class is meant only to be used internally by <a class="el" href="namespace_lucene.html">Lucene</a>; it's only public so it can be shared across packages. This means the API is freely subject to change, and, the class could be removed entirely, in any <a class="el" href="namespace_lucene.html">Lucene</a> release. Use directly at your own risk! </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00031">31</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ac6beae8b7a9e54bfd3c5cdfb9726c8d9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.AbstractAllTermDocs.AbstractAllTermDocs </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maxDoc</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00036">36</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a7c7bd6f0496d02b833fdd543d29900b2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.AbstractAllTermDocs.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees associated resources. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a9cc49d963030dda58f218ca274430dbb">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00104">104</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af79d55880da515fe511b13582e078f12"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.AbstractAllTermDocs.Dispose </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="_abstract_all_term_docs_8cs_source.html#l00109">109</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e13ac4bfff7fbcadced35b13e91dd0e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void Lucene.Net.Index.AbstractAllTermDocs.Dispose </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>disposing</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_all_term_docs.html#a25602c71e67b81ce2c1a41d167f84be9">Lucene.Net.Index.AllTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4856145e5c7345d2e0c2413a90bb2b70"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool Lucene.Net.Index.AbstractAllTermDocs.IsDeleted </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>doc</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_all_term_docs.html#a2824d5abc574f33191cde84843ca70ed">Lucene.Net.Index.AllTermDocs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3fc18c95fdbb653a29f2b8adaed8270d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.AbstractAllTermDocs.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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a5a07b58ff92edf95aff4fbc264eb12e7">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00068">68</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab5f92c641927b32867a7e42982042f67"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.AbstractAllTermDocs.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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a04438d982669143e564b4128e96dd6c9">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00073">73</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a071261b53fc25e98b4dbdb19f53fc6ce"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.AbstractAllTermDocs.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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a63eba164c41e26450d60753cd548cbcb">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00041">41</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adc0d97cbc3f9ce346ad30498e62d9c28"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.AbstractAllTermDocs.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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a3da74fa2092995ebe6e9bea544a2cd91">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00053">53</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6f5c207aa014ff16b99a8894798ad1ef"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.AbstractAllTermDocs.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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a860fa309506967c3206a28f470cde29e">Lucene.Net.Index.TermDocs</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00090">90</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a6106b99c25cf3e83360e2f9dc7b4d98a"></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.AbstractAllTermDocs.internalDoc = -1</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00034">34</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7682ab16e0b5205ff7a2756cec975054"></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.AbstractAllTermDocs.maxDoc</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00033">33</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="ae0cc2fb30d68edbd83a1880d422c6f92"></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.AbstractAllTermDocs.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>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00059">59</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3b7e02bd1c6672e7f95d767d06aa4ffc"></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.AbstractAllTermDocs.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>Definition at line <a class="el" href="_abstract_all_term_docs_8cs_source.html#l00064">64</a> of file <a class="el" href="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.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="_abstract_all_term_docs_8cs_source.html">AbstractAllTermDocs.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
