| <!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.FieldComparator.StringOrdValComparator 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_field_comparator.html">FieldComparator</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html">StringOrdValComparator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.FieldComparator.StringOrdValComparator Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Sorts by field's natural String sort order, using ordinals. This is functionally equivalent to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html" title="Sorts by field's natural String sort order. All comparisons are done using String.compareTo, which is slow for medium to large result sets but possibly very fast for very small results sets. ">FieldComparator.StringValComparator</a> , but it first resolves the string to their relative ordinal positions (using the index returned by <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a777a72fcb94c94dfa8a3c9e0a085aef4" title="Checks the internal cache for an appropriate entry, and if none is found reads the term values in fie...">FieldCache.GetStringIndex</a>), and does most comparisons using the ordinals. For medium to large results, this comparator will be much faster than <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html" title="Sorts by field's natural String sort order. All comparisons are done using String.compareTo, which is slow for medium to large result sets but possibly very fast for very small results sets. ">FieldComparator.StringValComparator</a>. For very small result sets it may be slower. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">Lucene.Net.Search.FieldComparator</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:a0f3f99667580f96504c2681d0f844830"><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_field_comparator_1_1_string_ord_val_comparator.html#a0f3f99667580f96504c2681d0f844830">StringOrdValComparator</a> (int numHits, System.String field, int sortPos, bool reversed)</td></tr> |
| <tr class="separator:a0f3f99667580f96504c2681d0f844830"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4fc025f2328f3d1397550d26010e630a"><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_field_comparator_1_1_string_ord_val_comparator.html#a4fc025f2328f3d1397550d26010e630a">Compare</a> (int slot1, int slot2)</td></tr> |
| <tr class="memdesc:a4fc025f2328f3d1397550d26010e630a"><td class="mdescLeft"> </td><td class="mdescRight">Compare hit at slot1 with hit at slot2. <a href="#a4fc025f2328f3d1397550d26010e630a"></a><br/></td></tr> |
| <tr class="separator:a4fc025f2328f3d1397550d26010e630a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2a6874ca5e4e48fa724ca8ba65cfc51"><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_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51">CompareBottom</a> (int doc)</td></tr> |
| <tr class="memdesc:ac2a6874ca5e4e48fa724ca8ba65cfc51"><td class="mdescLeft"> </td><td class="mdescRight">Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a4fc025f2328f3d1397550d26010e630a" title="Compare hit at slot1 with hit at slot2.">Compare(int,int)</a> } as if bottom were slot1 and the new document were slot 2. <a href="#ac2a6874ca5e4e48fa724ca8ba65cfc51"></a><br/></td></tr> |
| <tr class="separator:ac2a6874ca5e4e48fa724ca8ba65cfc51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0aa0ffb4b523589b9a2d317c2b582532"><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_field_comparator_1_1_string_ord_val_comparator.html#a0aa0ffb4b523589b9a2d317c2b582532">Copy</a> (int slot, int doc)</td></tr> |
| <tr class="memdesc:a0aa0ffb4b523589b9a2d317c2b582532"><td class="mdescLeft"> </td><td class="mdescRight">This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot. <a href="#a0aa0ffb4b523589b9a2d317c2b582532"></a><br/></td></tr> |
| <tr class="separator:a0aa0ffb4b523589b9a2d317c2b582532"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a041d4b4eb2f1979b430288154f53b4cf"><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_field_comparator_1_1_string_ord_val_comparator.html#a041d4b4eb2f1979b430288154f53b4cf">SetNextReader</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, int docBase)</td></tr> |
| <tr class="memdesc:a041d4b4eb2f1979b430288154f53b4cf"><td class="mdescLeft"> </td><td class="mdescRight">Set a new Reader. All doc correspond to the current Reader. <a href="#a041d4b4eb2f1979b430288154f53b4cf"></a><br/></td></tr> |
| <tr class="separator:a041d4b4eb2f1979b430288154f53b4cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8ba18ee1077ab3f3471c58a5f4de98a"><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_field_comparator_1_1_string_ord_val_comparator.html#aa8ba18ee1077ab3f3471c58a5f4de98a">SetBottom</a> (int bottom)</td></tr> |
| <tr class="memdesc:aa8ba18ee1077ab3f3471c58a5f4de98a"><td class="mdescLeft"> </td><td class="mdescRight">Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a> is called, you should compare against this slot. This will always be called before <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a>. <a href="#aa8ba18ee1077ab3f3471c58a5f4de98a"></a><br/></td></tr> |
| <tr class="separator:aa8ba18ee1077ab3f3471c58a5f4de98a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b4d0c4add178daad2d43e2bf38fa459"><td class="memItemLeft" align="right" valign="top">string[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a2b4d0c4add178daad2d43e2bf38fa459">GetValues</a> ()</td></tr> |
| <tr class="separator:a2b4d0c4add178daad2d43e2bf38fa459"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_field_comparator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">Lucene.Net.Search.FieldComparator</a></td></tr> |
| <tr class="memitem:abbd2eabb8ea3e83e39ab8af0945abd3a inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#abbd2eabb8ea3e83e39ab8af0945abd3a">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:abbd2eabb8ea3e83e39ab8af0945abd3a inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <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> to use in case a document's score is needed. <a href="#abbd2eabb8ea3e83e39ab8af0945abd3a"></a><br/></td></tr> |
| <tr class="separator:abbd2eabb8ea3e83e39ab8af0945abd3a inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><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:ac5effa074416bacb8451e787b4c4db6f"><td class="memItemLeft" align="right" valign="top">override IComparable </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac5effa074416bacb8451e787b4c4db6f">this[int slot]</a><code> [get]</code></td></tr> |
| <tr class="separator:ac5effa074416bacb8451e787b4c4db6f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0eefbbb3225ea5598e5bc062229bb2a1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a0eefbbb3225ea5598e5bc062229bb2a1">BottomSlot</a><code> [get]</code></td></tr> |
| <tr class="separator:a0eefbbb3225ea5598e5bc062229bb2a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aface59184f5502cf889c712f96ac6c03"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#aface59184f5502cf889c712f96ac6c03">Field</a><code> [get]</code></td></tr> |
| <tr class="separator:aface59184f5502cf889c712f96ac6c03"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_field_comparator')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">Lucene.Net.Search.FieldComparator</a></td></tr> |
| <tr class="memitem:a5f851ad6bc6a5cdf83ff60c1682ea06f inherit properties_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td class="memItemLeft" align="right" valign="top">abstract IComparable </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a5f851ad6bc6a5cdf83ff60c1682ea06f">this[int slot]</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5f851ad6bc6a5cdf83ff60c1682ea06f inherit properties_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td class="mdescLeft"> </td><td class="mdescRight">Return the actual value in the slot. <a href="#a5f851ad6bc6a5cdf83ff60c1682ea06f"></a><br/></td></tr> |
| <tr class="separator:a5f851ad6bc6a5cdf83ff60c1682ea06f inherit properties_class_lucene_1_1_net_1_1_search_1_1_field_comparator"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Sorts by field's natural String sort order, using ordinals. This is functionally equivalent to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html" title="Sorts by field's natural String sort order. All comparisons are done using String.compareTo, which is slow for medium to large result sets but possibly very fast for very small results sets. ">FieldComparator.StringValComparator</a> , but it first resolves the string to their relative ordinal positions (using the index returned by <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a777a72fcb94c94dfa8a3c9e0a085aef4" title="Checks the internal cache for an appropriate entry, and if none is found reads the term values in fie...">FieldCache.GetStringIndex</a>), and does most comparisons using the ordinals. For medium to large results, this comparator will be much faster than <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html" title="Sorts by field's natural String sort order. All comparisons are done using String.compareTo, which is slow for medium to large result sets but possibly very fast for very small results sets. ">FieldComparator.StringValComparator</a>. For very small result sets it may be slower. </p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00776">776</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a0f3f99667580f96504c2681d0f844830"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html">Lucene.Net.Search.FieldComparator.StringOrdValComparator.StringOrdValComparator</a> </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>numHits</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>sortPos</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>reversed</em> </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="_field_comparator_8cs_source.html#l00794">794</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a4fc025f2328f3d1397550d26010e630a"></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.FieldComparator.StringOrdValComparator.Compare </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slot1</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slot2</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>Compare hit at slot1 with hit at slot2. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">slot1</td><td>first slot to compare </td></tr> |
| <tr><td class="paramname">slot2</td><td>second slot to compare </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal </dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a28ba9799a7d196d57f207316d10980f4">Lucene.Net.Search.FieldComparator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00804">804</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac2a6874ca5e4e48fa724ca8ba65cfc51"></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.FieldComparator.StringOrdValComparator.CompareBottom </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>Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a4fc025f2328f3d1397550d26010e630a" title="Compare hit at slot1 with hit at slot2.">Compare(int,int)</a> } as if bottom were slot1 and the new document were slot 2. </p> |
| <p>For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">doc</td><td>that was hit </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal. </dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#ae42153a2b6bcda6ec3d927300cbe88f9">Lucene.Net.Search.FieldComparator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00832">832</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0aa0ffb4b523589b9a2d317c2b582532"></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.FieldComparator.StringOrdValComparator.Copy </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slot</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>doc</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>This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">slot</td><td>which slot to copy the hit to </td></tr> |
| <tr><td class="paramname">doc</td><td>docID relative to current reader </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a72c8b7f7605057e2c3813b4c683cc8c7">Lucene.Net.Search.FieldComparator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00898">898</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2b4d0c4add178daad2d43e2bf38fa459"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string [] Lucene.Net.Search.FieldComparator.StringOrdValComparator.GetValues </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00939">939</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa8ba18ee1077ab3f3471c58a5f4de98a"></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.FieldComparator.StringOrdValComparator.SetBottom </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slot</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>Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a> is called, you should compare against this slot. This will always be called before <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">slot</td><td>the currently weakest (sorted last) slot in the queue </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1223cfea27cc15832f0b7bce525edd75">Lucene.Net.Search.FieldComparator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00921">921</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a041d4b4eb2f1979b430288154f53b4cf"></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.FieldComparator.StringOrdValComparator.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>Set a new Reader. All doc correspond to the current Reader. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>current reader </td></tr> |
| <tr><td class="paramname">docBase</td><td>docBase of this reader </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IOException </throws> <throws> IOException </throws> </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1b280e1cf1ee223bce3e369fe29ad1c5">Lucene.Net.Search.FieldComparator</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00907">907</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a0eefbbb3225ea5598e5bc062229bb2a1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Search.FieldComparator.StringOrdValComparator.BottomSlot</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="_field_comparator_8cs_source.html#l00945">945</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aface59184f5502cf889c712f96ac6c03"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Lucene.Net.Search.FieldComparator.StringOrdValComparator.Field</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="_field_comparator_8cs_source.html#l00950">950</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac5effa074416bacb8451e787b4c4db6f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override IComparable Lucene.Net.Search.FieldComparator.StringOrdValComparator.this[int slot]</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="_field_comparator_8cs_source.html#l00935">935</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.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="_field_comparator_8cs_source.html">FieldComparator.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> |
