blob: 843c5e37519731ef7d5703cb7faa833c18394a97 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">FieldEnumerator< T ></a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html">TermEnumerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The enumerator over the terms in an index.
<a href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</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:afeeda0ef1c0a0678a7168b11c70fd388"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#afeeda0ef1c0a0678a7168b11c70fd388">TermEnumerator</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_enum.html">TermEnum</a> termEnum, <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">TermDocs</a> termDocs, string field, FieldEnumerator&lt; T &gt; enclosing)</td></tr>
<tr class="memdesc:afeeda0ef1c0a0678a7168b11c70fd388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor. <a href="#afeeda0ef1c0a0678a7168b11c70fd388"></a><br/></td></tr>
<tr class="separator:afeeda0ef1c0a0678a7168b11c70fd388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab98a8feeff6e798d64d0f2feef3667d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#ab98a8feeff6e798d64d0f2feef3667d7">MoveNext</a> ()</td></tr>
<tr class="memdesc:ab98a8feeff6e798d64d0f2feef3667d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance to the next item. <a href="#ab98a8feeff6e798d64d0f2feef3667d7"></a><br/></td></tr>
<tr class="separator:ab98a8feeff6e798d64d0f2feef3667d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d9b0474ef6636c3a7f182d879b6d54f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#a1d9b0474ef6636c3a7f182d879b6d54f">Reset</a> ()</td></tr>
<tr class="memdesc:a1d9b0474ef6636c3a7f182d879b6d54f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the enumerator to the beginngin. <a href="#a1d9b0474ef6636c3a7f182d879b6d54f"></a><br/></td></tr>
<tr class="separator:a1d9b0474ef6636c3a7f182d879b6d54f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fcb69926b0496cc355d1328a7ddc2fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#a7fcb69926b0496cc355d1328a7ddc2fe">Dispose</a> ()</td></tr>
<tr class="separator:a7fcb69926b0496cc355d1328a7ddc2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25ddee10ea5419ed8c9feecb890617ac"><td class="memItemLeft" align="right" valign="top">IEnumerator&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#a25ddee10ea5419ed8c9feecb890617ac">GetEnumerator</a> ()</td></tr>
<tr class="memdesc:a25ddee10ea5419ed8c9feecb890617ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to IEnumerator-T-."/&gt; <a href="#a25ddee10ea5419ed8c9feecb890617ac"></a><br/></td></tr>
<tr class="separator:a25ddee10ea5419ed8c9feecb890617ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</a></td></tr>
<tr class="memitem:ad7d9f1aea450472c854d07df887a21fa inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#ad7d9f1aea450472c854d07df887a21fa">Dispose</a> ()</td></tr>
<tr class="memdesc:ad7d9f1aea450472c854d07df887a21fa inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispose of the instance. <a href="#ad7d9f1aea450472c854d07df887a21fa"></a><br/></td></tr>
<tr class="separator:ad7d9f1aea450472c854d07df887a21fa inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</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:a6a65b9b235d815297ff450f18e55b465"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#a6a65b9b235d815297ff450f18e55b465">fieldName</a></td></tr>
<tr class="memdesc:a6a65b9b235d815297ff450f18e55b465"><td class="mdescLeft">&#160;</td><td class="mdescRight">The field name, if any for the enum. <a href="#a6a65b9b235d815297ff450f18e55b465"></a><br/></td></tr>
<tr class="separator:a6a65b9b235d815297ff450f18e55b465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</a></td></tr>
<tr class="memitem:ae6765a92d1ed66f04689cdb54d3c1f1f inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#ae6765a92d1ed66f04689cdb54d3c1f1f">includeDocs</a></td></tr>
<tr class="memdesc:ae6765a92d1ed66f04689cdb54d3c1f1f inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the enumerator will include <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating &lt;document, frequency&gt; pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. <a href="#ae6765a92d1ed66f04689cdb54d3c1f1f"></a><br/></td></tr>
<tr class="separator:ae6765a92d1ed66f04689cdb54d3c1f1f inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02c905fb5e3c851c969bf8390a1cd713 inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">TermEnumerator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#a02c905fb5e3c851c969bf8390a1cd713">tEnum</a></td></tr>
<tr class="memdesc:a02c905fb5e3c851c969bf8390a1cd713 inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The specialized <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> enumerator. <a href="#a02c905fb5e3c851c969bf8390a1cd713"></a><br/></td></tr>
<tr class="separator:a02c905fb5e3c851c969bf8390a1cd713 inherit pro_attribs_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a20b3fdf63e3be1afdc4632a46fa389ed"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html#a20b3fdf63e3be1afdc4632a46fa389ed">Current</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a20b3fdf63e3be1afdc4632a46fa389ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current item in the enumerator. <a href="#a20b3fdf63e3be1afdc4632a46fa389ed"></a><br/></td></tr>
<tr class="separator:a20b3fdf63e3be1afdc4632a46fa389ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</a></td></tr>
<tr class="memitem:ac6b4e3b40e3d2b3e2c82dd9290db2b25 inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">TermEnumerator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#ac6b4e3b40e3d2b3e2c82dd9290db2b25">Terms</a><code> [get]</code></td></tr>
<tr class="memdesc:ac6b4e3b40e3d2b3e2c82dd9290db2b25 inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the enumerator for the terms. <a href="#ac6b4e3b40e3d2b3e2c82dd9290db2b25"></a><br/></td></tr>
<tr class="separator:ac6b4e3b40e3d2b3e2c82dd9290db2b25 inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9977258bdfdd90e6456fb2190bfde75d inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_doc_enumerator_1_1_term_doc_using_terms_enumerator.html">TermDocEnumerator.TermDocUsingTermsEnumerator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#a9977258bdfdd90e6456fb2190bfde75d">Docs</a><code> [get]</code></td></tr>
<tr class="memdesc:a9977258bdfdd90e6456fb2190bfde75d inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the enumerator for the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating &lt;document, frequency&gt; pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. <a href="#a9977258bdfdd90e6456fb2190bfde75d"></a><br/></td></tr>
<tr class="separator:a9977258bdfdd90e6456fb2190bfde75d inherit properties_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</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_field_enumerator_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html">Lucene.Net.Index.FieldEnumerator&lt; T &gt;</a></td></tr>
<tr class="memitem:aee5dad1f15cb3fdc750137074b632e7a inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#aee5dad1f15cb3fdc750137074b632e7a">Init</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string field)</td></tr>
<tr class="memdesc:aee5dad1f15cb3fdc750137074b632e7a inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor. <a href="#aee5dad1f15cb3fdc750137074b632e7a"></a><br/></td></tr>
<tr class="separator:aee5dad1f15cb3fdc750137074b632e7a inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac421cba1ebcd6dbe477f059e574f8307 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#ac421cba1ebcd6dbe477f059e574f8307">Init</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string fieldName, bool <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#ae6765a92d1ed66f04689cdb54d3c1f1f">includeDocs</a>)</td></tr>
<tr class="memdesc:ac421cba1ebcd6dbe477f059e574f8307 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor. <a href="#ac421cba1ebcd6dbe477f059e574f8307"></a><br/></td></tr>
<tr class="separator:ac421cba1ebcd6dbe477f059e574f8307 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0ad76752f697b90b5ad41119545fd18 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#aa0ad76752f697b90b5ad41119545fd18">TryParse</a> (string s)</td></tr>
<tr class="memdesc:aa0ad76752f697b90b5ad41119545fd18 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to attempt to parse out the value from the encoded string and sets the value of Current. <a href="#aa0ad76752f697b90b5ad41119545fd18"></a><br/></td></tr>
<tr class="separator:aa0ad76752f697b90b5ad41119545fd18 inherit pro_methods_class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The enumerator over the terms in an index. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00172">172</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afeeda0ef1c0a0678a7168b11c70fd388"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.TermEnumerator </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>&#160;</td>
<td class="paramname"><em>termEnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html">TermDocs</a>&#160;</td>
<td class="paramname"><em>termDocs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FieldEnumerator&lt; T &gt;&#160;</td>
<td class="paramname"><em>enclosing</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">termEnum</td><td>The <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> to wrap.</td></tr>
<tr><td class="paramname">termDocs</td><td>The <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating &lt;document, frequency&gt; pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a> to wrap.</td></tr>
<tr><td class="paramname">field</td><td></td></tr>
<tr><td class="paramname">enclosing</td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00211">211</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7fcb69926b0496cc355d1328a7ddc2fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.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="_field_enumerator_8cs_source.html#l00290">290</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a25ddee10ea5419ed8c9feecb890617ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerator&lt;T&gt; Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.GetEnumerator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor to IEnumerator-T-."/&gt; </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00303">303</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab98a8feeff6e798d64d0f2feef3667d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.MoveNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance to the next item. </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00246">246</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a1d9b0474ef6636c3a7f182d879b6d54f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the enumerator to the beginngin. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00281">281</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6a65b9b235d815297ff450f18e55b465"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.fieldName</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>The field name, if any for the enum. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00192">192</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a20b3fdf63e3be1afdc4632a46fa389ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T Lucene.Net.Index.FieldEnumerator&lt; T &gt;.TermEnumerator.Current</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current item in the enumerator. </p>
<p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00225">225</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Core/Index/<a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>