Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html
blob: 2bcf7a2aa6d40a307589de66fece680d61770924 [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.DocFieldProcessorPerThread 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_doc_field_processor_per_thread.html">DocFieldProcessorPerThread</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.DocFieldProcessorPerThread Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Gathers all Fieldables for a document under the same name, updates <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_infos.html" title="Access to the Fieldable Info file that describes document fields and whether or not they are indexed...">FieldInfos</a>, and calls per-field consumers to process field by field.
<a href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html">Lucene.Net.Index.DocConsumerPerThread</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 &#160;</td><td class="memItemRight" valign="bottom"><b>PerDoc</b></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a165513d6c3e71022424b740dd318a9b5"><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_doc_field_processor_per_thread.html#a165513d6c3e71022424b740dd318a9b5">DocFieldProcessorPerThread</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer_thread_state.html">DocumentsWriterThreadState</a> threadState, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor.html">DocFieldProcessor</a> docFieldProcessor)</td></tr>
<tr class="separator:a165513d6c3e71022424b740dd318a9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a634a3b010a942b3157bdb2e098cd9726"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html#a634a3b010a942b3157bdb2e098cd9726">Abort</a> ()</td></tr>
<tr class="separator:a634a3b010a942b3157bdb2e098cd9726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb08386001f36d3ac815cffc1b45e53b"><td class="memItemLeft" align="right" valign="top">System.Collections.Generic.ICollection<br class="typebreak"/>
&lt; <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html">DocFieldConsumerPerField</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html#afb08386001f36d3ac815cffc1b45e53b">Fields</a> ()</td></tr>
<tr class="separator:afb08386001f36d3ac815cffc1b45e53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7c87d367f0eaeac4c77b8ce6b98fa47"><td class="memItemLeft" align="right" valign="top">override DocumentsWriter.DocWriter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_processor_per_thread.html#ad7c87d367f0eaeac4c77b8ce6b98fa47">ProcessDocument</a> ()</td></tr>
<tr class="memdesc:ad7c87d367f0eaeac4c77b8ce6b98fa47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the document. If there is something for this document to be done in docID order, you should encapsulate that as a DocumentsWriter.DocWriter and return it. <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> then calls finish() on this object when it's its turn. <a href="#ad7c87d367f0eaeac4c77b8ce6b98fa47"></a><br/></td></tr>
<tr class="separator:ad7c87d367f0eaeac4c77b8ce6b98fa47"><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>Gathers all Fieldables for a document under the same name, updates <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_infos.html" title="Access to the Fieldable Info file that describes document fields and whether or not they are indexed...">FieldInfos</a>, and calls per-field consumers to process field by field. </p>
<p>Currently, only a single thread visits the fields, sequentially, for processing. </p>
<p>Definition at line <a class="el" href="_doc_field_processor_per_thread_8cs_source.html#l00035">35</a> of file <a class="el" href="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a165513d6c3e71022424b740dd318a9b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.DocFieldProcessorPerThread.DocFieldProcessorPerThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer_thread_state.html">DocumentsWriterThreadState</a>&#160;</td>
<td class="paramname"><em>threadState</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_doc_field_processor.html">DocFieldProcessor</a>&#160;</td>
<td class="paramname"><em>docFieldProcessor</em>&#160;</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="_doc_field_processor_per_thread_8cs_source.html#l00061">61</a> of file <a class="el" href="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a634a3b010a942b3157bdb2e098cd9726"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.DocFieldProcessorPerThread.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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html#ad734878f41728aba9bff646d8b8dcac1">Lucene.Net.Index.DocConsumerPerThread</a>.</p>
<p>Definition at line <a class="el" href="_doc_field_processor_per_thread_8cs_source.html#l00071">71</a> of file <a class="el" href="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afb08386001f36d3ac815cffc1b45e53b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">System.Collections.Generic.ICollection&lt;<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html">DocFieldConsumerPerField</a>&gt; Lucene.Net.Index.DocFieldProcessorPerThread.Fields </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="_doc_field_processor_per_thread_8cs_source.html#l00087">87</a> of file <a class="el" href="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad7c87d367f0eaeac4c77b8ce6b98fa47"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override DocumentsWriter.DocWriter Lucene.Net.Index.DocFieldProcessorPerThread.ProcessDocument </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Process the document. If there is something for this document to be done in docID order, you should encapsulate that as a DocumentsWriter.DocWriter and return it. <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> then calls finish() on this object when it's its turn. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_consumer_per_thread.html#a5c5e21cec7859e8664bc34178bde693e">Lucene.Net.Index.DocConsumerPerThread</a>.</p>
<p>Definition at line <a class="el" href="_doc_field_processor_per_thread_8cs_source.html#l00174">174</a> of file <a class="el" href="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.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="_doc_field_processor_per_thread_8cs_source.html">DocFieldProcessorPerThread.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 &#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>