blob: 96865f9ca6f73fa3593655de4ed57f4246853dad [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.DocInverterPerField 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_inverter_per_field.html">DocInverterPerField</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter_per_field-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.DocInverterPerField Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds state for inverting all occurrences of a single field in the document. This class doesn't do anything itself; instead, it forwards the tokens produced by analysis to its own consumer (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_inverted_doc_consumer_per_field.html">InvertedDocConsumerPerField</a>). It also interacts with an endConsumer (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_inverted_doc_end_consumer_per_field.html">InvertedDocEndConsumerPerField</a>).
<a href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter_per_field.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html">Lucene.Net.Index.DocFieldConsumerPerField</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:a614907fc75eb17d8e7ac9b177389fc3a"><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_inverter_per_field.html#a614907fc75eb17d8e7ac9b177389fc3a">DocInverterPerField</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter_per_thread.html">DocInverterPerThread</a> perThread, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_field_info.html">FieldInfo</a> fieldInfo)</td></tr>
<tr class="separator:a614907fc75eb17d8e7ac9b177389fc3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6928d8874750f99acebb55a6031b4712"><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_inverter_per_field.html#a6928d8874750f99acebb55a6031b4712">Abort</a> ()</td></tr>
<tr class="separator:a6928d8874750f99acebb55a6031b4712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d26edbc4e1f77bce2c94a472c8bf3ad"><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_inverter_per_field.html#a0d26edbc4e1f77bce2c94a472c8bf3ad">ProcessFields</a> (<a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a>[] fields, int count)</td></tr>
<tr class="memdesc:a0d26edbc4e1f77bce2c94a472c8bf3ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes all occurrences of a single field <a href="#a0d26edbc4e1f77bce2c94a472c8bf3ad"></a><br/></td></tr>
<tr class="separator:a0d26edbc4e1f77bce2c94a472c8bf3ad"><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>Holds state for inverting all occurrences of a single field in the document. This class doesn't do anything itself; instead, it forwards the tokens produced by analysis to its own consumer (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_inverted_doc_consumer_per_field.html">InvertedDocConsumerPerField</a>). It also interacts with an endConsumer (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_inverted_doc_end_consumer_per_field.html">InvertedDocEndConsumerPerField</a>). </p>
<p>Definition at line <a class="el" href="_doc_inverter_per_field_8cs_source.html#l00034">34</a> of file <a class="el" href="_doc_inverter_per_field_8cs_source.html">DocInverterPerField.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a614907fc75eb17d8e7ac9b177389fc3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.DocInverterPerField.DocInverterPerField </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_inverter_per_thread.html">DocInverterPerThread</a>&#160;</td>
<td class="paramname"><em>perThread</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_info.html">FieldInfo</a>&#160;</td>
<td class="paramname"><em>fieldInfo</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_inverter_per_field_8cs_source.html#l00044">44</a> of file <a class="el" href="_doc_inverter_per_field_8cs_source.html">DocInverterPerField.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6928d8874750f99acebb55a6031b4712"></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.DocInverterPerField.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_field_consumer_per_field.html#a654ffc0a7626f5f5e7d01326937763ad">Lucene.Net.Index.DocFieldConsumerPerField</a>.</p>
<p>Definition at line <a class="el" href="_doc_inverter_per_field_8cs_source.html#l00054">54</a> of file <a class="el" href="_doc_inverter_per_field_8cs_source.html">DocInverterPerField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0d26edbc4e1f77bce2c94a472c8bf3ad"></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.DocInverterPerField.ProcessFields </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a>[]&#160;</td>
<td class="paramname"><em>fields</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>count</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Processes all occurrences of a single field </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_doc_field_consumer_per_field.html#acb0fd02a7fbd61f449705a7f462864f9">Lucene.Net.Index.DocFieldConsumerPerField</a>.</p>
<p>Definition at line <a class="el" href="_doc_inverter_per_field_8cs_source.html#l00060">60</a> of file <a class="el" href="_doc_inverter_per_field_8cs_source.html">DocInverterPerField.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_inverter_per_field_8cs_source.html">DocInverterPerField.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>