| <!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.FilterIndexReader.FilterTermPositions 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_filter_index_reader.html">FilterIndexReader</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html">FilterTermPositions</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="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.FilterIndexReader.FilterTermPositions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for filtering <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> implementations. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html#details">More...</a></p> |
| |
| <p>Inherits <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>, 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:a8864a78c5278b56cd48b107da2f9f42c"><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_filter_index_reader_1_1_filter_term_positions.html#a8864a78c5278b56cd48b107da2f9f42c">FilterTermPositions</a> (<a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">TermPositions</a> in_Renamed)</td></tr> |
| <tr class="separator:a8864a78c5278b56cd48b107da2f9f42c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af447a9ba7b4c0f5beeb74d2a459ea6a2"><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_filter_index_reader_1_1_filter_term_positions.html#af447a9ba7b4c0f5beeb74d2a459ea6a2">NextPosition</a> ()</td></tr> |
| <tr class="memdesc:af447a9ba7b4c0f5beeb74d2a459ea6a2"><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="#af447a9ba7b4c0f5beeb74d2a459ea6a2"></a><br/></td></tr> |
| <tr class="separator:af447a9ba7b4c0f5beeb74d2a459ea6a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af9d27490f609fa0038ebd09607277de3"><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_filter_index_reader_1_1_filter_term_positions.html#af9d27490f609fa0038ebd09607277de3">GetPayload</a> (byte[] data, int offset)</td></tr> |
| <tr class="memdesc:af9d27490f609fa0038ebd09607277de3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the payload data at the current term position. This is invalid until <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html#af447a9ba7b4c0f5beeb74d2a459ea6a2" 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. This method must not be called more than once after each call of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html#af447a9ba7b4c0f5beeb74d2a459ea6a2" title="Returns next position in the current document. It is an error to call this more than TermDocs...">NextPosition()</a>. However, payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons.<br/> |
| <a href="#af9d27490f609fa0038ebd09607277de3"></a><br/></td></tr> |
| <tr class="separator:af9d27490f609fa0038ebd09607277de3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <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></td></tr> |
| <tr class="memitem:af147d73ced6d3ad84d6c7434a84da526 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#af147d73ced6d3ad84d6c7434a84da526">FilterTermDocs</a> (<a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">TermDocs</a> in_Renamed)</td></tr> |
| <tr class="separator:af147d73ced6d3ad84d6c7434a84da526 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac65f4a87cda1d5b38a727fe9d3b732b5 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#ac65f4a87cda1d5b38a727fe9d3b732b5">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:ac65f4a87cda1d5b38a727fe9d3b732b5 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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="#ac65f4a87cda1d5b38a727fe9d3b732b5"></a><br/></td></tr> |
| <tr class="separator:ac65f4a87cda1d5b38a727fe9d3b732b5 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae435894514bde8cd52082c30fef376de inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#ae435894514bde8cd52082c30fef376de">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:ae435894514bde8cd52082c30fef376de inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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="#ae435894514bde8cd52082c30fef376de"></a><br/></td></tr> |
| <tr class="separator:ae435894514bde8cd52082c30fef376de inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ee64285677dfcae65bbecddb50a0745 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a8ee64285677dfcae65bbecddb50a0745">Next</a> ()</td></tr> |
| <tr class="memdesc:a8ee64285677dfcae65bbecddb50a0745 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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="#a8ee64285677dfcae65bbecddb50a0745"></a><br/></td></tr> |
| <tr class="separator:a8ee64285677dfcae65bbecddb50a0745 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a130ad2b0c7ad8703e4322badf925761e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a130ad2b0c7ad8703e4322badf925761e">Read</a> (int[] docs, int[] freqs)</td></tr> |
| <tr class="memdesc:a130ad2b0c7ad8703e4322badf925761e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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="#a130ad2b0c7ad8703e4322badf925761e"></a><br/></td></tr> |
| <tr class="separator:a130ad2b0c7ad8703e4322badf925761e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67caa260b0a17380dda92d07c4282027 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a67caa260b0a17380dda92d07c4282027">SkipTo</a> (int i)</td></tr> |
| <tr class="memdesc:a67caa260b0a17380dda92d07c4282027 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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="#a67caa260b0a17380dda92d07c4282027"></a><br/></td></tr> |
| <tr class="separator:a67caa260b0a17380dda92d07c4282027 inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0bc7051fe6b1f12feafdd94083c9193b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a0bc7051fe6b1f12feafdd94083c9193b">Close</a> ()</td></tr> |
| <tr class="memdesc:a0bc7051fe6b1f12feafdd94083c9193b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="mdescLeft"> </td><td class="mdescRight">Frees associated resources. <a href="#a0bc7051fe6b1f12feafdd94083c9193b"></a><br/></td></tr> |
| <tr class="separator:a0bc7051fe6b1f12feafdd94083c9193b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e1690116773280b79165f3fa0c3c77a inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a1e1690116773280b79165f3fa0c3c77a">Dispose</a> ()</td></tr> |
| <tr class="separator:a1e1690116773280b79165f3fa0c3c77a inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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:a0dd256bb0aa872970afd8398e5e9f187"><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_filter_index_reader_1_1_filter_term_positions.html#a0dd256bb0aa872970afd8398e5e9f187">PayloadLength</a><code> [get]</code></td></tr> |
| <tr class="separator:a0dd256bb0aa872970afd8398e5e9f187"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a06add5d491aa62318c404bad5e9b772b"><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_filter_index_reader_1_1_filter_term_positions.html#a06add5d491aa62318c404bad5e9b772b">IsPayloadAvailable</a><code> [get]</code></td></tr> |
| <tr class="separator:a06add5d491aa62318c404bad5e9b772b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs')"><img src="closed.png" alt="-"/> Properties inherited from <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></td></tr> |
| <tr class="memitem:a6bddcab568c6f8253d55674192dd7881 inherit properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a6bddcab568c6f8253d55674192dd7881">Doc</a><code> [get]</code></td></tr> |
| <tr class="separator:a6bddcab568c6f8253d55674192dd7881 inherit properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f22e032f5130dd842ffce68b3ed7795 inherit properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a6f22e032f5130dd842ffce68b3ed7795">Freq</a><code> [get]</code></td></tr> |
| <tr class="separator:a6f22e032f5130dd842ffce68b3ed7795 inherit properties_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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> |
| <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> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <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></td></tr> |
| <tr class="memitem:a34a7cd1397fd5f3a8a4274b978fc7d5f inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_docs"><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_filter_index_reader_1_1_filter_term_docs.html#a34a7cd1397fd5f3a8a4274b978fc7d5f">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:a34a7cd1397fd5f3a8a4274b978fc7d5f inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_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 filtering <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> implementations. </p> |
| |
| <p>Definition at line <a class="el" href="_filter_index_reader_8cs_source.html#l00101">101</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a8864a78c5278b56cd48b107da2f9f42c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.FilterIndexReader.FilterTermPositions.FilterTermPositions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">TermPositions</a> </td> |
| <td class="paramname"><em>in_Renamed</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_filter_index_reader_8cs_source.html#l00104">104</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af9d27490f609fa0038ebd09607277de3"></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.FilterIndexReader.FilterTermPositions.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>Returns the payload data at the current term position. This is invalid until <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html#af447a9ba7b4c0f5beeb74d2a459ea6a2" 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. This method must not be called more than once after each call of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_filter_index_reader_1_1_filter_term_positions.html#af447a9ba7b4c0f5beeb74d2a459ea6a2" title="Returns next position in the current document. It is an error to call this more than TermDocs...">NextPosition()</a>. However, payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons.<br/> |
| </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>the array into which the data of this payload is to be stored, if it is big enough; otherwise, a new byte[] array is allocated for this purpose. </td></tr> |
| <tr><td class="paramname">offset</td><td>the offset in the array into which the data of this payload is to be stored. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a byte[] array containing the data of this payload </dd></dl> |
| <p><throws> IOException </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="_filter_index_reader_8cs_source.html#l00118">118</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af447a9ba7b4c0f5beeb74d2a459ea6a2"></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.FilterIndexReader.FilterTermPositions.NextPosition </td> |
| <td>(</td> |
| <td class="paramname"></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>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="_filter_index_reader_8cs_source.html#l00108">108</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a06add5d491aa62318c404bad5e9b772b"></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.FilterIndexReader.FilterTermPositions.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>Definition at line <a class="el" href="_filter_index_reader_8cs_source.html#l00127">127</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0dd256bb0aa872970afd8398e5e9f187"></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.FilterIndexReader.FilterTermPositions.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>Definition at line <a class="el" href="_filter_index_reader_8cs_source.html#l00114">114</a> of file <a class="el" href="_filter_index_reader_8cs_source.html">FilterIndexReader.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="_filter_index_reader_8cs_source.html">FilterIndexReader.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:50 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
