| <!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.DocFieldConsumer 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_doc_field_consumer.html">DocFieldConsumer</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.DocFieldConsumer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html">Lucene.Net.Index.DocInverter</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:a73baf3411c46fd0c8d3ee03077a6c9be"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer.html#a73baf3411c46fd0c8d3ee03077a6c9be">Flush</a> (IDictionary< <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_thread.html">DocFieldConsumerPerThread</a>, ICollection< <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html">DocFieldConsumerPerField</a> >> threadsAndFields, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a> state)</td></tr> |
| <tr class="memdesc:a73baf3411c46fd0c8d3ee03077a6c9be"><td class="mdescLeft"> </td><td class="mdescRight">Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> decides to create a new segment <a href="#a73baf3411c46fd0c8d3ee03077a6c9be"></a><br/></td></tr> |
| <tr class="separator:a73baf3411c46fd0c8d3ee03077a6c9be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fbf4ced5d85f4562031e4b53966d3a9"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer.html#a3fbf4ced5d85f4562031e4b53966d3a9">CloseDocStore</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a> state)</td></tr> |
| <tr class="memdesc:a3fbf4ced5d85f4562031e4b53966d3a9"><td class="mdescLeft"> </td><td class="mdescRight">Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> decides to close the doc stores <a href="#a3fbf4ced5d85f4562031e4b53966d3a9"></a><br/></td></tr> |
| <tr class="separator:a3fbf4ced5d85f4562031e4b53966d3a9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa192152faf22897d9344d9a46f794f7d"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer.html#aa192152faf22897d9344d9a46f794f7d">Abort</a> ()</td></tr> |
| <tr class="memdesc:aa192152faf22897d9344d9a46f794f7d"><td class="mdescLeft"> </td><td class="mdescRight">Called when an aborting exception is hit <a href="#aa192152faf22897d9344d9a46f794f7d"></a><br/></td></tr> |
| <tr class="separator:aa192152faf22897d9344d9a46f794f7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0a56b87a2bdb99506144abc97040e6b"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_thread.html">DocFieldConsumerPerThread</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer.html#aa0a56b87a2bdb99506144abc97040e6b">AddThread</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html">DocFieldProcessorPerThread</a> docFieldProcessorPerThread)</td></tr> |
| <tr class="memdesc:aa0a56b87a2bdb99506144abc97040e6b"><td class="mdescLeft"> </td><td class="mdescRight">Add a new thread <a href="#aa0a56b87a2bdb99506144abc97040e6b"></a><br/></td></tr> |
| <tr class="separator:aa0a56b87a2bdb99506144abc97040e6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70c8516745c63359f487c4805d8ec78b"><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_doc_field_consumer.html#a70c8516745c63359f487c4805d8ec78b">FreeRAM</a> ()</td></tr> |
| <tr class="memdesc:a70c8516745c63359f487c4805d8ec78b"><td class="mdescLeft"> </td><td class="mdescRight">Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed. <a href="#a70c8516745c63359f487c4805d8ec78b"></a><br/></td></tr> |
| <tr class="separator:a70c8516745c63359f487c4805d8ec78b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"> |
| <p>Definition at line <a class="el" href="_doc_field_consumer_8cs_source.html#l00024">24</a> of file <a class="el" href="_doc_field_consumer_8cs_source.html">DocFieldConsumer.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aa192152faf22897d9344d9a46f794f7d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void Lucene.Net.Index.DocFieldConsumer.Abort </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called when an aborting exception is hit </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html#a26c8f37a5da7a5a3b01ed9ce4995cdcc">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html#aaa1e5bced8d9cb548318b1537875531c">Lucene.Net.Index.DocInverter</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa0a56b87a2bdb99506144abc97040e6b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_thread.html">DocFieldConsumerPerThread</a> Lucene.Net.Index.DocFieldConsumer.AddThread </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html">DocFieldProcessorPerThread</a> </td> |
| <td class="paramname"><em>docFieldProcessorPerThread</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a new thread </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html#abe93a75871ed2c58bd245ac64aacc422">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html#a7376823f2b5599a913ce46a44c76f676">Lucene.Net.Index.DocInverter</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3fbf4ced5d85f4562031e4b53966d3a9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void Lucene.Net.Index.DocFieldConsumer.CloseDocStore </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a> </td> |
| <td class="paramname"><em>state</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> decides to close the doc stores </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html#ac973bb52c1138b8a4b5e622d2c924fc7">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html#a8c399bc11798073febe74af8d84afe0c">Lucene.Net.Index.DocInverter</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a73baf3411c46fd0c8d3ee03077a6c9be"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void Lucene.Net.Index.DocFieldConsumer.Flush </td> |
| <td>(</td> |
| <td class="paramtype">IDictionary< <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_thread.html">DocFieldConsumerPerThread</a>, ICollection< <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html">DocFieldConsumerPerField</a> >> </td> |
| <td class="paramname"><em>threadsAndFields</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_segment_write_state.html">SegmentWriteState</a> </td> |
| <td class="paramname"><em>state</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> decides to create a new segment </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html#a038fc9acb014ac48f7e2609a7d890707">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html#a616c9ab09af3412d2c21504f83dec721">Lucene.Net.Index.DocInverter</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a70c8516745c63359f487c4805d8ec78b"></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.DocFieldConsumer.FreeRAM </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumers.html#a030f46885bfac865afb4424d6f9a49ce">Lucene.Net.Index.DocFieldConsumers</a>, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter.html#a0a7ebc9a60252b2fbe18abb2101cf7b7">Lucene.Net.Index.DocInverter</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_doc_field_consumer_8cs_source.html">DocFieldConsumer.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> |
