| <!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< T > Class Template 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_field_enumerator_3_01_t_01_4.html">FieldEnumerator< T ></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="#pro-attribs">Protected Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.FieldEnumerator< T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p> |
| <a href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#details">More...</a></p> |
| |
| <p>Inherits IDisposable.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4_1_1_term_enumerator.html">Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator</a>, <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">Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator</a>, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_numeric_field_enum_3_01_t_01_4.html">Lucene.Net.Index.NumericFieldEnum< T ></a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_string_field_enumerator.html">Lucene.Net.Index.StringFieldEnumerator</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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">TermEnumerator</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:ad7d9f1aea450472c854d07df887a21fa"><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_field_enumerator_3_01_t_01_4.html#ad7d9f1aea450472c854d07df887a21fa">Dispose</a> ()</td></tr> |
| <tr class="memdesc:ad7d9f1aea450472c854d07df887a21fa"><td class="mdescLeft"> </td><td class="mdescRight">Dispose of the instance. <a href="#ad7d9f1aea450472c854d07df887a21fa"></a><br/></td></tr> |
| <tr class="separator:ad7d9f1aea450472c854d07df887a21fa"><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:aee5dad1f15cb3fdc750137074b632e7a"><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_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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac421cba1ebcd6dbe477f059e574f8307"><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_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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0ad76752f697b90b5ad41119545fd18"><td class="memItemLeft" align="right" valign="top">abstract bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_enumerator_3_01_t_01_4.html#aa0ad76752f697b90b5ad41119545fd18">TryParse</a> (string s)</td></tr> |
| <tr class="memdesc:aa0ad76752f697b90b5ad41119545fd18"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:ae6765a92d1ed66f04689cdb54d3c1f1f"><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_field_enumerator_3_01_t_01_4.html#ae6765a92d1ed66f04689cdb54d3c1f1f">includeDocs</a></td></tr> |
| <tr class="memdesc:ae6765a92d1ed66f04689cdb54d3c1f1f"><td class="mdescLeft"> </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 <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. <a href="#ae6765a92d1ed66f04689cdb54d3c1f1f"></a><br/></td></tr> |
| <tr class="separator:ae6765a92d1ed66f04689cdb54d3c1f1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a02c905fb5e3c851c969bf8390a1cd713"><td class="memItemLeft" align="right" valign="top">TermEnumerator </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"><td class="mdescLeft"> </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"><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:ac6b4e3b40e3d2b3e2c82dd9290db2b25"><td class="memItemLeft" align="right" valign="top">TermEnumerator </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"><td class="mdescLeft"> </td><td class="mdescRight">Access the enumerator for the terms. <a href="#ac6b4e3b40e3d2b3e2c82dd9290db2b25"></a><br/></td></tr> |
| <tr class="separator:ac6b4e3b40e3d2b3e2c82dd9290db2b25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9977258bdfdd90e6456fb2190bfde75d"><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> </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"><td class="mdescLeft"> </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 <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. <a href="#a9977258bdfdd90e6456fb2190bfde75d"></a><br/></td></tr> |
| <tr class="separator:a9977258bdfdd90e6456fb2190bfde75d"><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 the typed enumerators.</p> |
| <p>There are five implementations of FieldEnumerator<em>T</em> for strings, integers, longs, floats, and doubles. The numeric enumerators support both standard Field and NumericField implementations. The string and numeric enumerators have slightly different options, but both should be used within a using statment to close the underlying TermEnum/TermDocs. Refer to the unit tests for usage examples. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>The type of data being enumerated.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00049">49</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ad7d9f1aea450472c854d07df887a21fa"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.FieldEnumerator< T >.Dispose </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Dispose of the instance. </p> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00150">150</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee5dad1f15cb3fdc750137074b632e7a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.FieldEnumerator< T >.Init </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>reader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>field</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">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>The index reader to read from.</td></tr> |
| <tr><td class="paramname">field</td><td>The field to enumerate.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00087">87</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac421cba1ebcd6dbe477f059e574f8307"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.FieldEnumerator< T >.Init </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>reader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>includeDocs</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">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>The index reader to read from.</td></tr> |
| <tr><td class="paramname">fieldName</td><td>The field to enumerate.</td></tr> |
| <tr><td class="paramname">includeDocs</td><td>Whether this enumerator will support <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_docs.html" title="TermDocs provides an interface for enumerating <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00099">99</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa0ad76752f697b90b5ad41119545fd18"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool Lucene.Net.Index.FieldEnumerator< T >.TryParse </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Method to attempt to parse out the value from the encoded string and sets the value of Current. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">s</td><td>The encoded string.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if the value was successfully parsed, false if we reached the end of encoded values in the fiele and only the tries remain.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_numeric_field_enum_3_01_t_01_4.html#a1c4106ecf21693ed12a4dacca412a274">Lucene.Net.Index.NumericFieldEnum< T ></a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_string_field_enumerator.html#a6d92a797d81854cc5dfaa648dad39ec3">Lucene.Net.Index.StringFieldEnumerator</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="ae6765a92d1ed66f04689cdb54d3c1f1f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.FieldEnumerator< T >.includeDocs</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>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 <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00054">54</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a02c905fb5e3c851c969bf8390a1cd713"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TermEnumerator Lucene.Net.Index.FieldEnumerator< T >.tEnum</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 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. </p> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00069">69</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="a9977258bdfdd90e6456fb2190bfde75d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><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> Lucene.Net.Index.FieldEnumerator< T >.Docs</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>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 <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number. ">TermDocs</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00131">131</a> of file <a class="el" href="_field_enumerator_8cs_source.html">FieldEnumerator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac6b4e3b40e3d2b3e2c82dd9290db2b25"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TermEnumerator Lucene.Net.Index.FieldEnumerator< T >.Terms</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>Access the enumerator for the terms. </p> |
| |
| <p>Definition at line <a class="el" href="_field_enumerator_8cs_source.html#l00123">123</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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
