blob: b125843a4f143eb37bd002eef26344bf153b8838 [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.Search.PositiveScoresOnlyCollector 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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html">PositiveScoresOnlyCollector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.PositiveScoresOnlyCollector Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a> implementation which wraps another <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a> and makes sure only documents with scores &gt; 0 are collected.
<a href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Lucene.Net.Search.Collector</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:a6679ee739130b4bd60910cf6a645ad0b"><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_search_1_1_positive_scores_only_collector.html#a6679ee739130b4bd60910cf6a645ad0b">PositiveScoresOnlyCollector</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a> c)</td></tr>
<tr class="separator:a6679ee739130b4bd60910cf6a645ad0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1f6497efeb1a072b86f9a1bfcedaeb6"><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_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6">Collect</a> (int doc)</td></tr>
<tr class="memdesc:ae1f6497efeb1a072b86f9a1bfcedaeb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called once for every document matching a query, with the unbased document number. <a href="#ae1f6497efeb1a072b86f9a1bfcedaeb6"></a><br/></td></tr>
<tr class="separator:ae1f6497efeb1a072b86f9a1bfcedaeb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9483f8889796a6ea366920c83e0de6a"><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_search_1_1_positive_scores_only_collector.html#af9483f8889796a6ea366920c83e0de6a">SetNextReader</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, int docBase)</td></tr>
<tr class="memdesc:af9483f8889796a6ea366920c83e0de6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before collecting from each IndexReader. All doc ids in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a> will correspond to reader. <a href="#af9483f8889796a6ea366920c83e0de6a"></a><br/></td></tr>
<tr class="separator:af9483f8889796a6ea366920c83e0de6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2694d0b548173c51a10045a8d7bc8b2"><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_search_1_1_positive_scores_only_collector.html#ac2694d0b548173c51a10045a8d7bc8b2">SetScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Scorer</a> scorer)</td></tr>
<tr class="memdesc:ac2694d0b548173c51a10045a8d7bc8b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before successive calls to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a>. Implementations that need the score of the current document (passed-in to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a>), should save the passed-in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> and call scorer.score() when needed. <a href="#ac2694d0b548173c51a10045a8d7bc8b2"></a><br/></td></tr>
<tr class="separator:ac2694d0b548173c51a10045a8d7bc8b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a76ab1c26109d99136424d54cfa63ac3c"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#a76ab1c26109d99136424d54cfa63ac3c">AcceptsDocsOutOfOrder</a><code> [get]</code></td></tr>
<tr class="separator:a76ab1c26109d99136424d54cfa63ac3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_collector"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_collector')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Lucene.Net.Search.Collector</a></td></tr>
<tr class="memitem:a07ed980f78f4da95c2968646c8b0c279 inherit properties_class_lucene_1_1_net_1_1_search_1_1_collector"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#a07ed980f78f4da95c2968646c8b0c279">AcceptsDocsOutOfOrder</a><code> [get]</code></td></tr>
<tr class="memdesc:a07ed980f78f4da95c2968646c8b0c279 inherit properties_class_lucene_1_1_net_1_1_search_1_1_collector"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return <code>true</code> if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#a125e477dc1b59bbdb22fa71eeac4fd8b" title="Called once for every document matching a query, with the unbased document number.">Collect</a>. Most <a class="el" href="namespace_lucene.html">Lucene</a> <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_query.html" title="A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys. ">BooleanQuery</a>) can achieve faster searching if the <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a></code> allows them to deliver the docIDs out of order. Many collectors don't mind getting docIDs out of order, so it's important to return <code>true</code> here. <a href="#a07ed980f78f4da95c2968646c8b0c279"></a><br/></td></tr>
<tr class="separator:a07ed980f78f4da95c2968646c8b0c279 inherit properties_class_lucene_1_1_net_1_1_search_1_1_collector"><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>A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a> implementation which wraps another <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a> and makes sure only documents with scores &gt; 0 are collected. </p>
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00029">29</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6679ee739130b4bd60910cf6a645ad0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.PositiveScoresOnlyCollector.PositiveScoresOnlyCollector </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a>&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00035">35</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae1f6497efeb1a072b86f9a1bfcedaeb6"></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.Search.PositiveScoresOnlyCollector.Collect </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>doc</em></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>Called once for every document matching a query, with the unbased document number. </p>
<p>Note: This is called in an inner search loop. For good search performance, implementations of this method should not call <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html#a9d0023e8f18632fe0709e9c40155dbca" title="Expert: Returns the stored fields of document i.">Searcher.Doc(int)</a> or <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#ae5a8698ada40868908ea27f502337ee2" title="Returns the stored fields of the nth Document in this index. NOTE: for performance reasons...">Lucene.Net.Index.IndexReader.Document(int)</a> on every hit. Doing so can slow searches by an order of magnitude or more. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#a125e477dc1b59bbdb22fa71eeac4fd8b">Lucene.Net.Search.Collector</a>.</p>
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00040">40</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af9483f8889796a6ea366920c83e0de6a"></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.Search.PositiveScoresOnlyCollector.SetNextReader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docBase</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>Called before collecting from each IndexReader. All doc ids in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a> will correspond to reader. </p>
<p>Add docBase to the current IndexReaders internal document id to re-base ids in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>next IndexReader </td></tr>
<tr><td class="paramname">docBase</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#aa8ff0ddcfa363877a8bb87a31ff38d5d">Lucene.Net.Search.Collector</a>.</p>
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00048">48</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac2694d0b548173c51a10045a8d7bc8b2"></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.Search.PositiveScoresOnlyCollector.SetScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Scorer</a>&#160;</td>
<td class="paramname"><em>scorer</em></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>Called before successive calls to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a>. Implementations that need the score of the current document (passed-in to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_positive_scores_only_collector.html#ae1f6497efeb1a072b86f9a1bfcedaeb6" title="Called once for every document matching a query, with the unbased document number.">Collect(int)</a>), should save the passed-in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> and call scorer.score() when needed. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#aa8d9d434cf08dd3422210a7c00ec9e80">Lucene.Net.Search.Collector</a>.</p>
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00053">53</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a76ab1c26109d99136424d54cfa63ac3c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.PositiveScoresOnlyCollector.AcceptsDocsOutOfOrder</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_positive_scores_only_collector_8cs_source.html#l00062">62</a> of file <a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Search/<a class="el" href="_positive_scores_only_collector_8cs_source.html">PositiveScoresOnlyCollector.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:57 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>