Google Git
Sign in
apache / lucenenet-site / 5756e8464bcbc1d881d328dd6e0994e11a0ac391 / . / docs / 3.0.3 / d6 / db8 / class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html
blob: f11bd82983974e7782493820c1fd5c5c6b7f41c7 [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.DocConsumer 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 port of the Lucene search engine library, written in C# and targeted at .NET runtime users.</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 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</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="../../df/d7a/namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="../../d3/dd0/namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="../../da/d43/namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html">DocConsumer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d1/d52/class_lucene_1_1_net_1_1_index_1_1_doc_consumer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.DocConsumer 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="../../d3/db1/class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html">Lucene.Net.Index.DocFieldProcessor</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:a6b594810192993b6e436e73abefaf35c"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="../../d7/de2/class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html">DocConsumerPerThread</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html#a6b594810192993b6e436e73abefaf35c">AddThread</a> (<a class="el" href="../../d9/d74/class_lucene_1_1_net_1_1_index_1_1_documents_writer_thread_state.html">DocumentsWriterThreadState</a> perThread)</td></tr>
<tr class="separator:a6b594810192993b6e436e73abefaf35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0131fc303f92ef58c4927bafc112f9e8"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html#a0131fc303f92ef58c4927bafc112f9e8">Flush</a> (System.Collections.Generic.ICollection&lt; <a class="el" href="../../d7/de2/class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html">DocConsumerPerThread</a> &gt; threads, <a class="el" href="../../da/d19/class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a> state)</td></tr>
<tr class="separator:a0131fc303f92ef58c4927bafc112f9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5a2b4f19d24176d11e39da5383dab2a"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html#ae5a2b4f19d24176d11e39da5383dab2a">CloseDocStore</a> (<a class="el" href="../../da/d19/class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a> state)</td></tr>
<tr class="separator:ae5a2b4f19d24176d11e39da5383dab2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a588a4060b2728f8ad1ae6890ba59c0e2"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html#a588a4060b2728f8ad1ae6890ba59c0e2">Abort</a> ()</td></tr>
<tr class="separator:a588a4060b2728f8ad1ae6890ba59c0e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4abb417ae2b4489adeef9ec1bd93c63"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/class_lucene_1_1_net_1_1_index_1_1_doc_consumer.html#af4abb417ae2b4489adeef9ec1bd93c63">FreeRAM</a> ()</td></tr>
<tr class="separator:af4abb417ae2b4489adeef9ec1bd93c63"><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>Definition at line <a class="el" href="../../de/d56/_doc_consumer_8cs_source.html#l00023">23</a> of file <a class="el" href="../../de/d56/_doc_consumer_8cs_source.html">DocConsumer.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a588a4060b2728f8ad1ae6890ba59c0e2"></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.DocConsumer.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>Implemented in <a class="el" href="../../d3/db1/class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html#a6c6e896dc5370863ffb6f41ea225cae3">Lucene.Net.Index.DocFieldProcessor</a>.</p>
</div>
</div>
<a class="anchor" id="a6b594810192993b6e436e73abefaf35c"></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="../../d7/de2/class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html">DocConsumerPerThread</a> Lucene.Net.Index.DocConsumer.AddThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d74/class_lucene_1_1_net_1_1_index_1_1_documents_writer_thread_state.html">DocumentsWriterThreadState</a>&#160;</td>
<td class="paramname"><em>perThread</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>Implemented in <a class="el" href="../../d3/db1/class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html#a4653476df12c9901038c8464fe47ef46">Lucene.Net.Index.DocFieldProcessor</a>.</p>
</div>
</div>
<a class="anchor" id="ae5a2b4f19d24176d11e39da5383dab2a"></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.DocConsumer.CloseDocStore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../da/d19/class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a>&#160;</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>Implemented in <a class="el" href="../../d3/db1/class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html#adcfe5cee017c4a0a282115f39588b350">Lucene.Net.Index.DocFieldProcessor</a>.</p>
</div>
</div>
<a class="anchor" id="a0131fc303f92ef58c4927bafc112f9e8"></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.DocConsumer.Flush </td>
<td>(</td>
<td class="paramtype">System.Collections.Generic.ICollection&lt; <a class="el" href="../../d7/de2/class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html">DocConsumerPerThread</a> &gt;&#160;</td>
<td class="paramname"><em>threads</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../da/d19/class_lucene_1_1_net_1_1_index_1_1_segment_write_state.html">SegmentWriteState</a>&#160;</td>
<td class="paramname"><em>state</em>&#160;</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">
</div>
</div>
<a class="anchor" id="af4abb417ae2b4489adeef9ec1bd93c63"></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.DocConsumer.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>Implemented in <a class="el" href="../../d3/db1/class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html#a3d78ed87f2ce3cabc81c1ad0bead7ebf">Lucene.Net.Index.DocFieldProcessor</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Index/<a class="el" href="../../de/d56/_doc_consumer_8cs_source.html">DocConsumer.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:34:17 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>