| <!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.TermScorer 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_term_scorer.html">TermScorer</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_term_scorer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.TermScorer Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: A <code><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></code> for documents matching a <code>Term</code>. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Lucene.Net.Search.Scorer</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:ac5dd11d4abef92549b8e75e89465c1b4"><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_term_scorer.html#ac5dd11d4abef92549b8e75e89465c1b4">TermScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Weight</a> weight, <a class="el" href="_field_cache_impl_8cs.html#a058de2d1c801e53325f35357f213391f">TermDocs</a> td, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> similarity, byte[] norms)</td></tr> |
| <tr class="memdesc:ac5dd11d4abef92549b8e75e89465c1b4"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html" title="Expert: A Scorer for documents matching a Term.">TermScorer</a></code>. <a href="#ac5dd11d4abef92549b8e75e89465c1b4"></a><br/></td></tr> |
| <tr class="separator:ac5dd11d4abef92549b8e75e89465c1b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd323a94b22e851e0bc64dfc2deaa4f1"><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_term_scorer.html#abd323a94b22e851e0bc64dfc2deaa4f1">Score</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a> c)</td></tr> |
| <tr class="memdesc:abd323a94b22e851e0bc64dfc2deaa4f1"><td class="mdescLeft"> </td><td class="mdescRight">Scores and collects all matching documents. <a href="#abd323a94b22e851e0bc64dfc2deaa4f1"></a><br/></td></tr> |
| <tr class="separator:abd323a94b22e851e0bc64dfc2deaa4f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35902e45293e368a95685966fc302a5e"><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_term_scorer.html#a35902e45293e368a95685966fc302a5e">Score</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html">Collector</a> c, int end, int firstDocID)</td></tr> |
| <tr class="memdesc:a35902e45293e368a95685966fc302a5e"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Collects matching documents in a range. Hook for optimization. Note, <em>firstDocID</em> is added to ensure that <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc()</a> was called before this method. <a href="#a35902e45293e368a95685966fc302a5e"></a><br/></td></tr> |
| <tr class="separator:a35902e45293e368a95685966fc302a5e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab146caf07576a7c367ef21eee4fa9ca0"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ab146caf07576a7c367ef21eee4fa9ca0">DocID</a> ()</td></tr> |
| <tr class="memdesc:ab146caf07576a7c367ef21eee4fa9ca0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the following: </p> |
| <ul> |
| <li> |
| -1 or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#a976267c1d4641b5e0052de0b01540b1f" title="Advances to the next document matching the query. The iterator over the matching documents is buffe...">NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ae0542c3e46df1088c69dad8823589c69" title="Advances to the first match beyond the current whose document number is greater than or equal to a gi...">Advance(int)</a> were not called yet. </li> |
| <li> |
| <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if the iterator has exhausted. </li> |
| <li> |
| Otherwise it should return the doc ID it is currently on. </li> |
| </ul> |
| <a href="#ab146caf07576a7c367ef21eee4fa9ca0"></a><br/></td></tr> |
| <tr class="separator:ab146caf07576a7c367ef21eee4fa9ca0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a976267c1d4641b5e0052de0b01540b1f"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#a976267c1d4641b5e0052de0b01540b1f">NextDoc</a> ()</td></tr> |
| <tr class="memdesc:a976267c1d4641b5e0052de0b01540b1f"><td class="mdescLeft"> </td><td class="mdescRight">Advances to the next document matching the query. <br/> |
| The iterator over the matching documents is buffered using TermDocs.Read(int[],int[]). <a href="#a976267c1d4641b5e0052de0b01540b1f"></a><br/></td></tr> |
| <tr class="separator:a976267c1d4641b5e0052de0b01540b1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acddbfcd7b83ab30154f456d3b08338f1"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#acddbfcd7b83ab30154f456d3b08338f1">Score</a> ()</td></tr> |
| <tr class="memdesc:acddbfcd7b83ab30154f456d3b08338f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the score of the current document matching the query. Initially invalid, until <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">DocIdSetIterator.Advance(int)</a> is called the first time, or when called from within <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>. <a href="#acddbfcd7b83ab30154f456d3b08338f1"></a><br/></td></tr> |
| <tr class="separator:acddbfcd7b83ab30154f456d3b08338f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0542c3e46df1088c69dad8823589c69"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ae0542c3e46df1088c69dad8823589c69">Advance</a> (int target)</td></tr> |
| <tr class="memdesc:ae0542c3e46df1088c69dad8823589c69"><td class="mdescLeft"> </td><td class="mdescRight">Advances to the first match beyond the current whose document number is greater than or equal to a given target. <br/> |
| The implementation uses TermDocs.SkipTo(int). <a href="#ae0542c3e46df1088c69dad8823589c69"></a><br/></td></tr> |
| <tr class="separator:ae0542c3e46df1088c69dad8823589c69"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6e75677e399a939d0915078d47708e18"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#a6e75677e399a939d0915078d47708e18">ToString</a> ()</td></tr> |
| <tr class="memdesc:a6e75677e399a939d0915078d47708e18"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of this <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html" title="Expert: A Scorer for documents matching a Term.">TermScorer</a></code>. <a href="#a6e75677e399a939d0915078d47708e18"></a><br/></td></tr> |
| <tr class="separator:a6e75677e399a939d0915078d47708e18"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html">Lucene.Net.Search.DocIdSetIterator</a></td></tr> |
| <tr class="memitem:ac005b14762e519ad644745031fac2ad4 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator"><td class="memItemLeft" align="right" valign="top">static readonly int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4">NO_MORE_DOCS</a> = System.Int32.MaxValue</td></tr> |
| <tr class="memdesc:ac005b14762e519ad644745031fac2ad4 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator"><td class="mdescLeft"> </td><td class="mdescRight">When returned by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">NextDoc()</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">Advance(int)</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a617cbe6c07c261cc2cc86ad3d255152f" title="Returns the following: -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet...">DocID()</a> it means there are no more docs in the iterator. <a href="#ac005b14762e519ad644745031fac2ad4"></a><br/></td></tr> |
| <tr class="separator:ac005b14762e519ad644745031fac2ad4 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_scorer"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_scorer')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Lucene.Net.Search.Scorer</a></td></tr> |
| <tr class="memitem:aa2d07dddba4ce149cbd46abbfc139d8a inherit properties_class_lucene_1_1_net_1_1_search_1_1_scorer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html#aa2d07dddba4ce149cbd46abbfc139d8a">Similarity</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa2d07dddba4ce149cbd46abbfc139d8a inherit properties_class_lucene_1_1_net_1_1_search_1_1_scorer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a> implementation used by this scorer. <a href="#aa2d07dddba4ce149cbd46abbfc139d8a"></a><br/></td></tr> |
| <tr class="separator:aa2d07dddba4ce149cbd46abbfc139d8a inherit properties_class_lucene_1_1_net_1_1_search_1_1_scorer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: A <code><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></code> for documents matching a <code>Term</code>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00026">26</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ac5dd11d4abef92549b8e75e89465c1b4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.TermScorer.TermScorer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Weight</a> </td> |
| <td class="paramname"><em>weight</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="_field_cache_impl_8cs.html#a058de2d1c801e53325f35357f213391f">TermDocs</a> </td> |
| <td class="paramname"><em>td</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> </td> |
| <td class="paramname"><em>similarity</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>norms</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html" title="Expert: A Scorer for documents matching a Term.">TermScorer</a></code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">weight</td><td>The weight of the <code>Term</code> in the query. </td></tr> |
| <tr><td class="paramname">td</td><td>An iterator over the documents matching the <code>Term</code>. </td></tr> |
| <tr><td class="paramname">similarity</td><td>The <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a></code> implementation to be used for score computations. </td></tr> |
| <tr><td class="paramname">norms</td><td>The field norms of the document fields for the <code>Term</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00057">57</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ae0542c3e46df1088c69dad8823589c69"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Search.TermScorer.Advance </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>target</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>Advances to the first match beyond the current whose document number is greater than or equal to a given target. <br/> |
| The implementation uses TermDocs.SkipTo(int). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">target</td><td>The target document number. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the matching document or -1 if none exist. </dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983">Lucene.Net.Search.DocIdSetIterator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00151">151</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab146caf07576a7c367ef21eee4fa9ca0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Search.TermScorer.DocID </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>Returns the following: </p> |
| <ul> |
| <li> |
| -1 or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#a976267c1d4641b5e0052de0b01540b1f" title="Advances to the next document matching the query. The iterator over the matching documents is buffe...">NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ae0542c3e46df1088c69dad8823589c69" title="Advances to the first match beyond the current whose document number is greater than or equal to a gi...">Advance(int)</a> were not called yet. </li> |
| <li> |
| <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if the iterator has exhausted. </li> |
| <li> |
| Otherwise it should return the doc ID it is currently on. </li> |
| </ul> |
| </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a617cbe6c07c261cc2cc86ad3d255152f">Lucene.Net.Search.DocIdSetIterator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00101">101</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a976267c1d4641b5e0052de0b01540b1f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Search.TermScorer.NextDoc </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>Advances to the next document matching the query. <br/> |
| The iterator over the matching documents is buffered using TermDocs.Read(int[],int[]). </p> |
| <dl class="section return"><dt>Returns</dt><dd>the document matching the query or -1 if there are no more documents. </dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d">Lucene.Net.Search.DocIdSetIterator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00113">113</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abd323a94b22e851e0bc64dfc2deaa4f1"></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.TermScorer.Score </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><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>Scores and collects all matching documents.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">collector</td><td>The collector to which all matching documents are passed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html#a23e72c598a4e46bd528ed19b272fc687">Lucene.Net.Search.Scorer</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00068">68</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a35902e45293e368a95685966fc302a5e"></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.TermScorer.Score </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">int </td> |
| <td class="paramname"><em>max</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>firstDocID</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>Expert: Collects matching documents in a range. Hook for optimization. Note, <em>firstDocID</em> is added to ensure that <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc()</a> was called before this method. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">collector</td><td>The collector to which all matching documents are passed. </td></tr> |
| <tr><td class="paramname">max</td><td>Do not score documents past this. </td></tr> |
| <tr><td class="paramname">firstDocID</td><td>The first document ID (ensures <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc()</a> is called before this method. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if more matching documents may remain. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html#afbae24b7b3053a0e489fc8f18664f6a9">Lucene.Net.Search.Scorer</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00074">74</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acddbfcd7b83ab30154f456d3b08338f1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.TermScorer.Score </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>Returns the score of the current document matching the query. Initially invalid, until <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">DocIdSetIterator.Advance(int)</a> is called the first time, or when called from within <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>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html#a9e45575b3a407f5cb224b51405893c3f">Lucene.Net.Search.Scorer</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00133">133</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6e75677e399a939d0915078d47708e18"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Search.TermScorer.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a string representation of this <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html" title="Expert: A Scorer for documents matching a Term.">TermScorer</a></code>. </p> |
| |
| <p>Definition at line <a class="el" href="_term_scorer_8cs_source.html#l00179">179</a> of file <a class="el" href="_term_scorer_8cs_source.html">TermScorer.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="_term_scorer_8cs_source.html">TermScorer.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> |
