| <!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.TimeLimitingCollector 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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html">TimeLimitingCollector</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.TimeLimitingCollector Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html" title="The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowe...">TimeLimitingCollector</a> is used to timeout search requests that take longer than the maximum allowed search time limit. After this time is exceeded, the search thread is stopped by throwing a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a>. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_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="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html">TimeExceededException</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Thrown when elapsed search time exceeds allowed search time. <a href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:aab7c12780edf259f55042fecf90ecaf6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#aab7c12780edf259f55042fecf90ecaf6">TimeLimitingCollector</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a> collector, long timeAllowed)</td></tr> |
| <tr class="memdesc:aab7c12780edf259f55042fecf90ecaf6"><td class="mdescLeft"> </td><td class="mdescRight">Create a TimeLimitedCollector wrapper over 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> with a specified timeout. <a href="#aab7c12780edf259f55042fecf90ecaf6"></a><br/></td></tr> |
| <tr class="separator:aab7c12780edf259f55042fecf90ecaf6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2bd9898cd61387b02277e98a42497451"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451">Collect</a> (int doc)</td></tr> |
| <tr class="memdesc:a2bd9898cd61387b02277e98a42497451"><td class="mdescLeft"> </td><td class="mdescRight">Calls <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.">Collector.Collect(int)</a> on the decorated <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> unless the allowed time has passed, in which case it throws an exception. <a href="#a2bd9898cd61387b02277e98a42497451"></a><br/></td></tr> |
| <tr class="separator:a2bd9898cd61387b02277e98a42497451"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb6a8d9b61637385eae21703872a4bee"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#afb6a8d9b61637385eae21703872a4bee">SetNextReader</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, int base_Renamed)</td></tr> |
| <tr class="memdesc:afb6a8d9b61637385eae21703872a4bee"><td class="mdescLeft"> </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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">Collect(int)</a> will correspond to reader. <a href="#afb6a8d9b61637385eae21703872a4bee"></a><br/></td></tr> |
| <tr class="separator:afb6a8d9b61637385eae21703872a4bee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47f045a3b6aea81b78c833ef3ada3ac7"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a47f045a3b6aea81b78c833ef3ada3ac7">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:a47f045a3b6aea81b78c833ef3ada3ac7"><td class="mdescLeft"> </td><td class="mdescRight">Called before successive calls to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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="#a47f045a3b6aea81b78c833ef3ada3ac7"></a><br/></td></tr> |
| <tr class="separator:a47f045a3b6aea81b78c833ef3ada3ac7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a0516aa9dcb84c3318716450440410330"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a0516aa9dcb84c3318716450440410330">DEFAULT_RESOLUTION</a> = 20</td></tr> |
| <tr class="memdesc:a0516aa9dcb84c3318716450440410330"><td class="mdescLeft"> </td><td class="mdescRight">Default timer resolution. <a href="#a0516aa9dcb84c3318716450440410330"></a><br/></td></tr> |
| <tr class="separator:a0516aa9dcb84c3318716450440410330"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d5b0a4b247a9aab3938279414556e4d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a0d5b0a4b247a9aab3938279414556e4d">DEFAULT_GREEDY</a> = false</td></tr> |
| <tr class="memdesc:a0d5b0a4b247a9aab3938279414556e4d"><td class="mdescLeft"> </td><td class="mdescRight">Default for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a425826883eb7931fc3f9530c69c43dc1" title="Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector...">IsGreedy()</a>. <a href="#a0d5b0a4b247a9aab3938279414556e4d"></a><br/></td></tr> |
| <tr class="separator:a0d5b0a4b247a9aab3938279414556e4d"><td class="memSeparator" colspan="2"> </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:a32488cc640081af86287d38cef923db0"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a32488cc640081af86287d38cef923db0">Resolution</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a32488cc640081af86287d38cef923db0"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the timer resolution. The default timer resolution is 20 milliseconds. This means that a search required to take no longer than 800 milliseconds may be stopped after 780 to 820 milliseconds. <br/> |
| Note that: </p> |
| <ul> |
| <li> |
| Finer (smaller) resolution is more accurate but less efficient. </li> |
| <li> |
| Setting resolution to less than 5 milliseconds will be silently modified to 5 milliseconds. </li> |
| <li> |
| Setting resolution smaller than current resolution might take effect only after current resolution. (Assume current resolution of 20 milliseconds is modified to 5 milliseconds, then it can take up to 20 milliseconds for the change to have effect. </li> |
| </ul> |
| <a href="#a32488cc640081af86287d38cef923db0"></a><br/></td></tr> |
| <tr class="separator:a32488cc640081af86287d38cef923db0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a425826883eb7931fc3f9530c69c43dc1"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a425826883eb7931fc3f9530c69c43dc1">IsGreedy</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a425826883eb7931fc3f9530c69c43dc1"><td class="mdescLeft"> </td><td class="mdescRight">Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector, upon a timeout, would throw a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a> without allowing the wrapped collector to collect current doc. A greedy one would first allow the wrapped hit collector to collect current doc and only then throw a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a>. <a href="#a425826883eb7931fc3f9530c69c43dc1"></a><br/></td></tr> |
| <tr class="separator:a425826883eb7931fc3f9530c69c43dc1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7f08513dc43e9c9b718c90d4a2d661a8"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a7f08513dc43e9c9b718c90d4a2d661a8">AcceptsDocsOutOfOrder</a><code> [get]</code></td></tr> |
| <tr class="separator:a7f08513dc43e9c9b718c90d4a2d661a8"><td class="memSeparator" colspan="2"> </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="-"/> 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 </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"> </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html" title="The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowe...">TimeLimitingCollector</a> is used to timeout search requests that take longer than the maximum allowed search time limit. After this time is exceeded, the search thread is stopped by throwing a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00030">30</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aab7c12780edf259f55042fecf90ecaf6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.TimeLimitingCollector.TimeLimitingCollector </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a> </td> |
| <td class="paramname"><em>collector</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>timeAllowed</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a TimeLimitedCollector wrapper over 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> with a specified timeout.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">collector</td><td>the wrapped <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> </td></tr> |
| <tr><td class="paramname">timeAllowed</td><td>max time allowed for collecting hits after which <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a> is thrown </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00143">143</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a2bd9898cd61387b02277e98a42497451"></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.TimeLimitingCollector.Collect </td> |
| <td>(</td> |
| <td class="paramtype">int </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>Calls <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.">Collector.Collect(int)</a> on the decorated <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> unless the allowed time has passed, in which case it throws an exception. </p> |
| <p><throws> <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a> </throws> </p> |
| <p>if the time allowed has exceeded. </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="_time_limiting_collector_8cs_source.html#l00194">194</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afb6a8d9b61637385eae21703872a4bee"></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.TimeLimitingCollector.SetNextReader </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> </td> |
| <td class="paramname"><em>reader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docBase</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">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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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="_time_limiting_collector_8cs_source.html#l00211">211</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a47f045a3b6aea81b78c833ef3ada3ac7"></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.TimeLimitingCollector.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> </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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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_time_limiting_collector.html#a2bd9898cd61387b02277e98a42497451" title="Calls Collector.Collect(int) on the decorated Collector unless the allowed time has passed...">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="_time_limiting_collector_8cs_source.html#l00217">217</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a0d5b0a4b247a9aab3938279414556e4d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Search.TimeLimitingCollector.DEFAULT_GREEDY = false</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a425826883eb7931fc3f9530c69c43dc1" title="Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector...">IsGreedy()</a>.</p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a425826883eb7931fc3f9530c69c43dc1" title="Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector...">IsGreedy()</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00045">45</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0516aa9dcb84c3318716450440410330"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const int Lucene.Net.Search.TimeLimitingCollector.DEFAULT_RESOLUTION = 20</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default timer resolution.</p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector.html#a32488cc640081af86287d38cef923db0" title="Gets or sets the timer resolution. The default timer resolution is 20 milliseconds. This means that a search required to take no longer than 800 milliseconds may be stopped after 780 to 820 milliseconds. Note that: Finer (smaller) resolution is more accurate but less efficient. Setting resolution to less than 5 milliseconds will be silently modified to 5 milliseconds. Setting resolution smaller than current resolution might take effect only after current resolution. (Assume current resolution of 20 milliseconds is modified to 5 milliseconds, then it can take up to 20 milliseconds for the change to have effect. ">Resolution</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00040">40</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a7f08513dc43e9c9b718c90d4a2d661a8"></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.TimeLimitingCollector.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="_time_limiting_collector_8cs_source.html#l00223">223</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a425826883eb7931fc3f9530c69c43dc1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Search.TimeLimitingCollector.IsGreedy</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector, upon a timeout, would throw a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a> without allowing the wrapped collector to collect current doc. A greedy one would first allow the wrapped hit collector to collect current doc and only then throw a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_time_limiting_collector_1_1_time_exceeded_exception.html" title="Thrown when elapsed search time exceeds allowed search time. ">TimeExceededException</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00182">182</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a32488cc640081af86287d38cef923db0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Lucene.Net.Search.TimeLimitingCollector.Resolution</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets or sets the timer resolution. The default timer resolution is 20 milliseconds. This means that a search required to take no longer than 800 milliseconds may be stopped after 780 to 820 milliseconds. <br/> |
| Note that: </p> |
| <ul> |
| <li> |
| Finer (smaller) resolution is more accurate but less efficient. </li> |
| <li> |
| Setting resolution to less than 5 milliseconds will be silently modified to 5 milliseconds. </li> |
| <li> |
| Setting resolution smaller than current resolution might take effect only after current resolution. (Assume current resolution of 20 milliseconds is modified to 5 milliseconds, then it can take up to 20 milliseconds for the change to have effect. </li> |
| </ul> |
| </p> |
| |
| <p>Definition at line <a class="el" href="_time_limiting_collector_8cs_source.html#l00166">166</a> of file <a class="el" href="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.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="_time_limiting_collector_8cs_source.html">TimeLimitingCollector.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
