| <!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.FieldsReader 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_fields_reader.html">FieldsReader</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="class_lucene_1_1_net_1_1_index_1_1_fields_reader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.FieldsReader Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>.fdx; files. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html#details">More...</a></p> |
| |
| <p>Inherits ICloneable, and IDisposable.</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:a7b7502f2a3526a0bbc28b34cee37a4a6"><td class="memItemLeft" align="right" valign="top">System.Object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html#a7b7502f2a3526a0bbc28b34cee37a4a6">Clone</a> ()</td></tr> |
| <tr class="memdesc:a7b7502f2a3526a0bbc28b34cee37a4a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns a cloned <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html" title="Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>...">FieldsReader</a> that shares open IndexInputs with the original one. It is the caller's job not to close the original <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html" title="Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>...">FieldsReader</a> until all clones are called (eg, currently <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html" title="NOTE: This API is new and still experimental (subject to change suddenly in the next release)...">SegmentReader</a> manages this logic). <a href="#a7b7502f2a3526a0bbc28b34cee37a4a6"></a><br/></td></tr> |
| <tr class="separator:a7b7502f2a3526a0bbc28b34cee37a4a6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e8f1fd962aa6de873935ab3efd801f6"><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_fields_reader.html#a2e8f1fd962aa6de873935ab3efd801f6">FieldsReader</a> (<a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> d, String segment, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_infos.html">FieldInfos</a> fn)</td></tr> |
| <tr class="separator:a2e8f1fd962aa6de873935ab3efd801f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe4dbaa7a17f636ec6df681239172154"><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_fields_reader.html#afe4dbaa7a17f636ec6df681239172154">Dispose</a> ()</td></tr> |
| <tr class="memdesc:afe4dbaa7a17f636ec6df681239172154"><td class="mdescLeft"> </td><td class="mdescRight">Closes the underlying <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html" title="Abstract base class for input from a file in a Directory. A random-access input stream. Used for all Lucene index input operations. ">Lucene.Net.Store.IndexInput</a> streams, including any ones associated with a lazy implementation of a Field. This means that the Fields values will not be accessible. <a href="#afe4dbaa7a17f636ec6df681239172154"></a><br/></td></tr> |
| <tr class="separator:afe4dbaa7a17f636ec6df681239172154"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae84ab4e542ff0a9fb5a289bd6413decd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html#ae84ab4e542ff0a9fb5a289bd6413decd">Size</a> ()</td></tr> |
| <tr class="separator:ae84ab4e542ff0a9fb5a289bd6413decd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a45a5c53ffc6dbd79d44b88807302be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html#a5a45a5c53ffc6dbd79d44b88807302be">Doc</a> (int n, <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html">FieldSelector</a> fieldSelector)</td></tr> |
| <tr class="separator:a5a45a5c53ffc6dbd79d44b88807302be"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Class responsible for access to stored document fields. </p> |
| <p>It uses <segment>.fdt and <segment>.fdx; files. </p> |
| |
| <p>Definition at line <a class="el" href="_fields_reader_8cs_source.html#l00037">37</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a2e8f1fd962aa6de873935ab3efd801f6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.FieldsReader.FieldsReader </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> </td> |
| <td class="paramname"><em>d</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>segment</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_infos.html">FieldInfos</a> </td> |
| <td class="paramname"><em>fn</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fields_reader_8cs_source.html#l00090">90</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a7b7502f2a3526a0bbc28b34cee37a4a6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.Object Lucene.Net.Index.FieldsReader.Clone </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a cloned <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html" title="Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>...">FieldsReader</a> that shares open IndexInputs with the original one. It is the caller's job not to close the original <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_fields_reader.html" title="Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>...">FieldsReader</a> until all clones are called (eg, currently <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html" title="NOTE: This API is new and still experimental (subject to change suddenly in the next release)...">SegmentReader</a> manages this logic). </p> |
| |
| <p>Definition at line <a class="el" href="_fields_reader_8cs_source.html#l00069">69</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afe4dbaa7a17f636ec6df681239172154"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.FieldsReader.Dispose </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the underlying <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html" title="Abstract base class for input from a file in a Directory. A random-access input stream. Used for all Lucene index input operations. ">Lucene.Net.Store.IndexInput</a> streams, including any ones associated with a lazy implementation of a Field. This means that the Fields values will not be accessible. </p> |
| <p><throws> IOException </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_fields_reader_8cs_source.html#l00175">175</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5a45a5c53ffc6dbd79d44b88807302be"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a> Lucene.Net.Index.FieldsReader.Doc </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>n</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html">FieldSelector</a> </td> |
| <td class="paramname"><em>fieldSelector</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fields_reader_8cs_source.html#l00223">223</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae84ab4e542ff0a9fb5a289bd6413decd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.FieldsReader.Size </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="_fields_reader_8cs_source.html#l00204">204</a> of file <a class="el" href="_fields_reader_8cs_source.html">FieldsReader.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="_fields_reader_8cs_source.html">FieldsReader.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> |
