| <!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.MultipleTermPositions 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_multiple_term_positions.html">MultipleTermPositions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.MultipleTermPositions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Allows you to iterate over the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html" title="TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples fo...">TermPositions</a> for multiple <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a>s as a single <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html" title="TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples fo...">TermPositions</a>. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#details">More...</a></p> |
| |
| <p>Inherits <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:a66ba6a23a73938d024e694d0a56c0576"><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_multiple_term_positions.html#a66ba6a23a73938d024e694d0a56c0576">MultipleTermPositions</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> indexReader, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>[] terms)</td></tr> |
| <tr class="memdesc:a66ba6a23a73938d024e694d0a56c0576"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <code><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html" title="Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions.">MultipleTermPositions</a></code> instance. <a href="#a66ba6a23a73938d024e694d0a56c0576"></a><br/></td></tr> |
| <tr class="separator:a66ba6a23a73938d024e694d0a56c0576"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3f5c6fcd956f980603663a39ebc5abf"><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_multiple_term_positions.html#ad3f5c6fcd956f980603663a39ebc5abf">Next</a> ()</td></tr> |
| <tr class="memdesc:ad3f5c6fcd956f980603663a39ebc5abf"><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="#ad3f5c6fcd956f980603663a39ebc5abf"></a><br/></td></tr> |
| <tr class="separator:ad3f5c6fcd956f980603663a39ebc5abf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a225afa1410d3a4f5e950d5e80ded30da"><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_multiple_term_positions.html#a225afa1410d3a4f5e950d5e80ded30da">NextPosition</a> ()</td></tr> |
| <tr class="memdesc:a225afa1410d3a4f5e950d5e80ded30da"><td class="mdescLeft"> </td><td class="mdescRight">Returns next position in the current document. It is an error to call this more than <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a9518490703cce46b57cf9f931b6edd7c" title="Returns the frequency of the term within the current document. This is invalid until Next() is called...">TermDocs.Freq()</a> times without calling <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...">TermDocs.Next()</a>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...">TermDocs.Next()</a> is called for the first time. <a href="#a225afa1410d3a4f5e950d5e80ded30da"></a><br/></td></tr> |
| <tr class="separator:a225afa1410d3a4f5e950d5e80ded30da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add7f1c250506dc1a0d9c40097a882cb9"><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_multiple_term_positions.html#add7f1c250506dc1a0d9c40097a882cb9">SkipTo</a> (int target)</td></tr> |
| <tr class="memdesc:add7f1c250506dc1a0d9c40097a882cb9"><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="#add7f1c250506dc1a0d9c40097a882cb9"></a><br/></td></tr> |
| <tr class="separator:add7f1c250506dc1a0d9c40097a882cb9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5088bec9145900a5aa93108df1d533e1"><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_multiple_term_positions.html#a5088bec9145900a5aa93108df1d533e1">Close</a> ()</td></tr> |
| <tr class="memdesc:a5088bec9145900a5aa93108df1d533e1"><td class="mdescLeft"> </td><td class="mdescRight">Frees associated resources. <a href="#a5088bec9145900a5aa93108df1d533e1"></a><br/></td></tr> |
| <tr class="separator:a5088bec9145900a5aa93108df1d533e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38f971e19fc7d6a58a478bc3c27cf160"><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_multiple_term_positions.html#a38f971e19fc7d6a58a478bc3c27cf160">Dispose</a> ()</td></tr> |
| <tr class="separator:a38f971e19fc7d6a58a478bc3c27cf160"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad9fbc7a04ffad45f4e78ee00f2fb06f0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#ad9fbc7a04ffad45f4e78ee00f2fb06f0">Seek</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> arg0)</td></tr> |
| <tr class="memdesc:ad9fbc7a04ffad45f4e78ee00f2fb06f0"><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <a href="#ad9fbc7a04ffad45f4e78ee00f2fb06f0"></a><br/></td></tr> |
| <tr class="separator:ad9fbc7a04ffad45f4e78ee00f2fb06f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac401403f9dc9aa5d27ac00eff46f1016"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#ac401403f9dc9aa5d27ac00eff46f1016">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:ac401403f9dc9aa5d27ac00eff46f1016"><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <a href="#ac401403f9dc9aa5d27ac00eff46f1016"></a><br/></td></tr> |
| <tr class="separator:ac401403f9dc9aa5d27ac00eff46f1016"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b4ac5d706c5e00d8645409d21c13089"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a4b4ac5d706c5e00d8645409d21c13089">Read</a> (int[] arg0, int[] arg1)</td></tr> |
| <tr class="memdesc:a4b4ac5d706c5e00d8645409d21c13089"><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <a href="#a4b4ac5d706c5e00d8645409d21c13089"></a><br/></td></tr> |
| <tr class="separator:a4b4ac5d706c5e00d8645409d21c13089"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a296679a5068c8aa7b263748094777677"><td class="memItemLeft" align="right" valign="top">virtual byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a296679a5068c8aa7b263748094777677">GetPayload</a> (byte[] data, int offset)</td></tr> |
| <tr class="memdesc:a296679a5068c8aa7b263748094777677"><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <a href="#a296679a5068c8aa7b263748094777677"></a><br/></td></tr> |
| <tr class="separator:a296679a5068c8aa7b263748094777677"><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:a65c1d395bacc8eb149669d7480872f0b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a65c1d395bacc8eb149669d7480872f0b">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:a65c1d395bacc8eb149669d7480872f0b"><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:aa7694141f2012653b2be16026146eda6"><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_multiple_term_positions.html#aa7694141f2012653b2be16026146eda6">Doc</a><code> [get]</code></td></tr> |
| <tr class="separator:aa7694141f2012653b2be16026146eda6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4bfe741ca8637f2b6395c545b656b782"><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_multiple_term_positions.html#a4bfe741ca8637f2b6395c545b656b782">Freq</a><code> [get]</code></td></tr> |
| <tr class="separator:a4bfe741ca8637f2b6395c545b656b782"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb6be1b321c1b47e1b450fff692de5b3"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#acb6be1b321c1b47e1b450fff692de5b3">PayloadLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acb6be1b321c1b47e1b450fff692de5b3"><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <a href="#acb6be1b321c1b47e1b450fff692de5b3"></a><br/></td></tr> |
| <tr class="separator:acb6be1b321c1b47e1b450fff692de5b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a829ee275e54f5f64e5cf92d2556f4606"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html#a829ee275e54f5f64e5cf92d2556f4606">IsPayloadAvailable</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a829ee275e54f5f64e5cf92d2556f4606"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#a829ee275e54f5f64e5cf92d2556f4606"></a><br/></td></tr> |
| <tr class="separator:a829ee275e54f5f64e5cf92d2556f4606"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">Lucene.Net.Index.TermPositions</a></td></tr> |
| <tr class="memitem:adbfebfa3b7a2bd01f3ba0eede68ea964 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><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_positions.html#adbfebfa3b7a2bd01f3ba0eede68ea964">PayloadLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adbfebfa3b7a2bd01f3ba0eede68ea964 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the payload at the current term position. This is invalid until <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#a122b95806c00faf647a614e84d33dc86" title="Returns next position in the current document. It is an error to call this more than TermDocs...">NextPosition()</a> is called for the first time.<br/> |
| <a href="#adbfebfa3b7a2bd01f3ba0eede68ea964"></a><br/></td></tr> |
| <tr class="separator:adbfebfa3b7a2bd01f3ba0eede68ea964 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1cf7385dfc2573ae86d21a6e67ea76c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><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_positions.html#af1cf7385dfc2573ae86d21a6e67ea76c">IsPayloadAvailable</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af1cf7385dfc2573ae86d21a6e67ea76c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#a122b95806c00faf647a614e84d33dc86" title="Returns next position in the current document. It is an error to call this more than TermDocs...">NextPosition()</a>. <a href="#af1cf7385dfc2573ae86d21a6e67ea76c"></a><br/></td></tr> |
| <tr class="separator:af1cf7385dfc2573ae86d21a6e67ea76c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_term_positions"><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>Allows you to iterate over the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html" title="TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples fo...">TermPositions</a> for multiple <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a>s as a single <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html" title="TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples fo...">TermPositions</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00029">29</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a66ba6a23a73938d024e694d0a56c0576"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.MultipleTermPositions.MultipleTermPositions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> </td> |
| <td class="paramname"><em>indexReader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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>terms</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new <code><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_multiple_term_positions.html" title="Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions.">MultipleTermPositions</a></code> instance. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">System.IO.IOException</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00117">117</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a5088bec9145900a5aa93108df1d533e1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00189">189</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38f971e19fc7d6a58a478bc3c27cf160"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00194">194</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a65c1d395bacc8eb149669d7480872f0b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.MultipleTermPositions.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00199">199</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a296679a5068c8aa7b263748094777677"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte [] Lucene.Net.Index.MultipleTermPositions.GetPayload </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>offset</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Not implemented.</p> |
| <p><throws> UnsupportedOperationException </throws> </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#ad3740df833e76a4850d88eaab68a9629">Lucene.Net.Index.TermPositions</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00243">243</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad3f5c6fcd956f980603663a39ebc5abf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00128">128</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a225afa1410d3a4f5e950d5e80ded30da"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.MultipleTermPositions.NextPosition </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns next position in the current document. It is an error to call this more than <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html#a9518490703cce46b57cf9f931b6edd7c" title="Returns the frequency of the term within the current document. This is invalid until Next() is called...">TermDocs.Freq()</a> times without calling <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...">TermDocs.Next()</a>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...">TermDocs.Next()</a> is called for the first time. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#a122b95806c00faf647a614e84d33dc86">Lucene.Net.Index.TermPositions</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00160">160</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4b4ac5d706c5e00d8645409d21c13089"></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.Index.MultipleTermPositions.Read </td> |
| <td>(</td> |
| <td class="paramtype">int[] </td> |
| <td class="paramname"><em>arg0</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int[] </td> |
| <td class="paramname"><em>arg1</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Not implemented.</p> |
| <p><throws> UnsupportedOperationException </throws> </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="_multiple_term_positions_8cs_source.html#l00228">228</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad9fbc7a04ffad45f4e78ee00f2fb06f0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.MultipleTermPositions.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>arg0</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Not implemented.</p> |
| <p><throws> UnsupportedOperationException </throws> </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="_multiple_term_positions_8cs_source.html#l00214">214</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac401403f9dc9aa5d27ac00eff46f1016"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.MultipleTermPositions.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Not implemented.</p> |
| <p><throws> UnsupportedOperationException </throws> </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="_multiple_term_positions_8cs_source.html#l00221">221</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="add7f1c250506dc1a0d9c40097a882cb9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00165">165</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="aa7694141f2012653b2be16026146eda6"></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.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00179">179</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4bfe741ca8637f2b6395c545b656b782"></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.MultipleTermPositions.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="_multiple_term_positions_8cs_source.html#l00184">184</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a829ee275e54f5f64e5cf92d2556f4606"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Index.MultipleTermPositions.IsPayloadAvailable</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></p> |
| <p>false </p> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00252">252</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acb6be1b321c1b47e1b450fff692de5b3"></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.Index.MultipleTermPositions.PayloadLength</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>Not implemented.</p> |
| <p><throws> UnsupportedOperationException </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_multiple_term_positions_8cs_source.html#l00237">237</a> of file <a class="el" href="_multiple_term_positions_8cs_source.html">MultipleTermPositions.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="_multiple_term_positions_8cs_source.html">MultipleTermPositions.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:54 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> |