blob: 4c20372bea53ee7e9320fe4f9a3e60c08e49e1f2 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Search.FieldComparator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">FieldComparator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.FieldComparator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Expert: a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> compares hits so as to determine their sort order when collecting the top results with <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_top_field_collector.html" title="A Collector that sorts by SortField using FieldComparators. See the Create method for instantiating a...">TopFieldCollector</a> . The concrete public <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> classes here correspond to the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html" title="Stores information about how to sort documents by terms in an individual field. Fields must be indexe...">SortField</a> types.
<a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html">Lucene.Net.Search.FieldComparator.ByteComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html">Lucene.Net.Search.FieldComparator.DocComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <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</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html">Lucene.Net.Search.FieldComparator.StringValComparator</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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html">ByteComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as byte (using FieldCache.GetBytes(Lucene.Net.Index.IndexReader,string) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html">DocComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sorts by ascending docID <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html">DoubleComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as double (using FieldCache.GetDoubles(Lucene.Net.Index.IndexReader,string) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html">FloatComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as float (using FieldCache.GetFloats(Lucene.Net.Index.IndexReader,string) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html">IntComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as int (using FieldCache.GetInts(Lucene.Net.Index.IndexReader,string) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html">LongComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as long (using FieldCache.GetLongs(Lucene.Net.Index.IndexReader,string) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html">RelevanceComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sorts by descending relevance. NOTE: if you are sorting only by descending relevance and then secondarily by ascending docID, peformance is faster using <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_top_score_doc_collector.html" title="A Collector implementation that collects the top-scoring hits, returning them as a TopDocs...">TopScoreDocCollector</a> directly (which <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html#a15a44f147c6f8a9a9cf56e47dd560c05" title="Finds the top n hits for query.">Searcher.Search(Query, int)</a> uses when no <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort.html" title="Encapsulates sort criteria for returned hits.">Sort</a> is specified). <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html">ShortComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses field's values as short (using FieldCache.GetShorts(IndexReader, string)) and sorts by ascending value <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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_comparator_locale.html">StringComparatorLocale</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sorts by a field's value using the Collator for a given Locale. <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">StringOrdValComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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&#39;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&#39;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><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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_val_comparator.html">StringValComparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <a href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a28ba9799a7d196d57f207316d10980f4"><td class="memItemLeft" align="right" valign="top">abstract int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a28ba9799a7d196d57f207316d10980f4">Compare</a> (int slot1, int slot2)</td></tr>
<tr class="memdesc:a28ba9799a7d196d57f207316d10980f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare hit at slot1 with hit at slot2. <a href="#a28ba9799a7d196d57f207316d10980f4"></a><br/></td></tr>
<tr class="separator:a28ba9799a7d196d57f207316d10980f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1223cfea27cc15832f0b7bce525edd75"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1223cfea27cc15832f0b7bce525edd75">SetBottom</a> (int slot)</td></tr>
<tr class="memdesc:a1223cfea27cc15832f0b7bce525edd75"><td class="mdescLeft">&#160;</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.html#ae42153a2b6bcda6ec3d927300cbe88f9" 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.html#ae42153a2b6bcda6ec3d927300cbe88f9" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a>. <a href="#a1223cfea27cc15832f0b7bce525edd75"></a><br/></td></tr>
<tr class="separator:a1223cfea27cc15832f0b7bce525edd75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae42153a2b6bcda6ec3d927300cbe88f9"><td class="memItemLeft" align="right" valign="top">abstract int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#ae42153a2b6bcda6ec3d927300cbe88f9">CompareBottom</a> (int doc)</td></tr>
<tr class="memdesc:ae42153a2b6bcda6ec3d927300cbe88f9"><td class="mdescLeft">&#160;</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.html#a28ba9799a7d196d57f207316d10980f4" 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="#ae42153a2b6bcda6ec3d927300cbe88f9"></a><br/></td></tr>
<tr class="separator:ae42153a2b6bcda6ec3d927300cbe88f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72c8b7f7605057e2c3813b4c683cc8c7"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a72c8b7f7605057e2c3813b4c683cc8c7">Copy</a> (int slot, int doc)</td></tr>
<tr class="memdesc:a72c8b7f7605057e2c3813b4c683cc8c7"><td class="mdescLeft">&#160;</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="#a72c8b7f7605057e2c3813b4c683cc8c7"></a><br/></td></tr>
<tr class="separator:a72c8b7f7605057e2c3813b4c683cc8c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b280e1cf1ee223bce3e369fe29ad1c5"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1b280e1cf1ee223bce3e369fe29ad1c5">SetNextReader</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, int docBase)</td></tr>
<tr class="memdesc:a1b280e1cf1ee223bce3e369fe29ad1c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new Reader. All doc correspond to the current Reader. <a href="#a1b280e1cf1ee223bce3e369fe29ad1c5"></a><br/></td></tr>
<tr class="separator:a1b280e1cf1ee223bce3e369fe29ad1c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd2eabb8ea3e83e39ab8af0945abd3a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a5f851ad6bc6a5cdf83ff60c1682ea06f"><td class="memItemLeft" align="right" valign="top">abstract IComparable&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the actual value in the slot. <a href="#a5f851ad6bc6a5cdf83ff60c1682ea06f"></a><br/></td></tr>
<tr class="separator:a5f851ad6bc6a5cdf83ff60c1682ea06f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Expert: a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> compares hits so as to determine their sort order when collecting the top results with <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_top_field_collector.html" title="A Collector that sorts by SortField using FieldComparators. See the Create method for instantiating a...">TopFieldCollector</a> . The concrete public <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> classes here correspond to the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html" title="Stores information about how to sort documents by terms in an individual field. Fields must be indexe...">SortField</a> types. </p>
<p>This API is designed to achieve high performance sorting, by exposing a tight interaction with <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_value_hit_queue.html" title="Expert: A hit queue for sorting by hits by terms in more than one field. Uses FieldCache.DEFAULT for maintaining internal term lookup tables.">FieldValueHitQueue</a> as it visits hits. Whenever a hit is competitive, it's enrolled into a virtual slot, which is an int ranging from 0 to numHits-1. The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> is made aware of segment transitions during searching in case any internal state it's tracking needs to be recomputed during these transitions.</p>
<p>A comparator must define these functions:</p>
<ul>
<li>
<p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a28ba9799a7d196d57f207316d10980f4" title="Compare hit at slot1 with hit at slot2.">Compare</a> Compare a hit at 'slot a' with hit 'slot b'.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1223cfea27cc15832f0b7bce525edd75" title="Set the bottom slot, ie the &quot;weakest&quot; (sorted last) entry in the queue. When CompareBottom is called...">SetBottom</a> This method is called by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_value_hit_queue.html" title="Expert: A hit queue for sorting by hits by terms in more than one field. Uses FieldCache.DEFAULT for maintaining internal term lookup tables.">FieldValueHitQueue</a> to notify the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html" title="Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top r...">FieldComparator</a> of the current weakest ("bottom") slot. Note that this slot may not hold the weakest value according to your comparator, in cases where your comparator is not the primary one (ie, is only used to break ties from the comparators before it).</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#ae42153a2b6bcda6ec3d927300cbe88f9" title="Compare the bottom of the queue with doc. This will only invoked after setBottom has been called...">CompareBottom</a> Compare a new hit (docID) against the "weakest" (bottom) entry in the queue.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a72c8b7f7605057e2c3813b4c683cc8c7" title="This method is called when a new hit is competitive. You should copy any state associated with this d...">Copy</a> Installs a new hit into the priority queue. The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_value_hit_queue.html" title="Expert: A hit queue for sorting by hits by terms in more than one field. Uses FieldCache.DEFAULT for maintaining internal term lookup tables.">FieldValueHitQueue</a> calls this method when a new hit is competitive.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html#a1b280e1cf1ee223bce3e369fe29ad1c5" title="Set a new Reader. All doc correspond to the current Reader.">SetNextReader</a> Invoked when the search is switching to the next segment. You may need to update internal state of the comparator, for example retrieving new values from the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>.</p>
<p class="endli"></p>
</li>
<li>
P:Lucene.Net.Search.FieldComparator.Item(System.Int32) Return the sort value stored in the specified slot. This is only called at the end of the search, in order to populate <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#aa8b082bfd9429a289d2c6462eaf2d28f" title="Expert: The values which are used to sort the referenced document. The order of these will match the ...">FieldDoc.fields</a> when returning the top results. </li>
</ul>
<p><b>NOTE:</b> This API is experimental and might change in incompatible ways in the next release. </p>
<p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00083">83</a> of file <a class="el" href="_field_comparator_8cs_source.html">FieldComparator.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a28ba9799a7d196d57f207316d10980f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.FieldComparator.Compare </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>slot1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>slot2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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 &lt; 0 if slot2's value is sorted after slot1, any N &gt; 0 if the slot2's value is sorted before slot1 and 0 if they are equal </dd></dl>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#a69fe0ca3ca86ec40bcfea0632f9459f2">Lucene.Net.Search.FieldComparator.StringValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a4fc025f2328f3d1397550d26010e630a">Lucene.Net.Search.FieldComparator.StringOrdValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#a2eb8f6e6a10dfc67513fb19a036fbe57">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#a49048c01c14031625c55c69145e60728">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#ae4d9d19ef9c5164cd9c8cebbe4ffa287">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#a401669c071faba41beb560addad31815">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#aefea2767ffe518b0f7bb919d8cf72f02">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#ae56ce22c3fd6c86ce231a1153b26964e">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#aca3d728469a21e1eed3f3d29d7bc9527">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#aa610359dd1a3dfb15a2d82b724e23f25">Lucene.Net.Search.FieldComparator.DocComparator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#ad3d124e05592337c4eeb7cacccfaa080">Lucene.Net.Search.FieldComparator.ByteComparator</a>.</p>
</div>
</div>
<a class="anchor" id="ae42153a2b6bcda6ec3d927300cbe88f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.FieldComparator.CompareBottom </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>doc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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.html#a28ba9799a7d196d57f207316d10980f4" 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 &lt; 0 if the doc's value is sorted after the bottom entry (not competitive), any N &gt; 0 if the doc's value is sorted before the bottom entry and 0 if they are equal. </dd></dl>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#a532f2f9e0ed1c5ef81135bc6fa1daafe">Lucene.Net.Search.FieldComparator.StringValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#ac2a6874ca5e4e48fa724ca8ba65cfc51">Lucene.Net.Search.FieldComparator.StringOrdValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#a4241925244c1e0dd0aef0d2561e86cab">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#ae66990c49e7ba24470d063683d9b779e">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#a5d40479c2eead00b0daf43853552875a">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#abef58a4a189f62bf5f4d1e2c8c0d03a5">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#acff353834704eb15e68bd97c506ab80d">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#afc759c1dae3a1c3a838c92bb54c41a15">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#af19872763c0f95f8cdb229b5dbce764f">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#a90f8ac2eebf1bf52701c752eb035f2dd">Lucene.Net.Search.FieldComparator.DocComparator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#ac4514b054e6330c957b63a7c3853adf2">Lucene.Net.Search.FieldComparator.ByteComparator</a>.</p>
</div>
</div>
<a class="anchor" id="a72c8b7f7605057e2c3813b4c683cc8c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Search.FieldComparator.Copy </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>doc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#a13687d5c200e8970348af1bf4ee17bab">Lucene.Net.Search.FieldComparator.StringValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a0aa0ffb4b523589b9a2d317c2b582532">Lucene.Net.Search.FieldComparator.StringOrdValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#a219724275c75d9169bdc3a8b67961b27">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#a0c00349da5821305f90b7dd6ec2bad26">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#a3f5bced3a3c4345192da2f29d75b1387">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#a529eacf29b85640f41032958ef7d1079">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#a19fa31db60f9ec641c603d38eae886e8">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#af95b7d6ed4a7db62b9e303e920026650">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#a111dfc3f1d71745cb3fcf3355e4d8749">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#a5be6211fe5bc6ae4491dba7df2ac7348">Lucene.Net.Search.FieldComparator.DocComparator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#af26cb27ad1674b5d8f6ce28fefd4ced2">Lucene.Net.Search.FieldComparator.ByteComparator</a>.</p>
</div>
</div>
<a class="anchor" id="a1223cfea27cc15832f0b7bce525edd75"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Search.FieldComparator.SetBottom </td>
<td>(</td>
<td class="paramtype">int&#160;</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">pure 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.html#ae42153a2b6bcda6ec3d927300cbe88f9" 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.html#ae42153a2b6bcda6ec3d927300cbe88f9" 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#a103ed7447c02182085f159d7846458aa">Lucene.Net.Search.FieldComparator.StringValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#aa8ba18ee1077ab3f3471c58a5f4de98a">Lucene.Net.Search.FieldComparator.StringOrdValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#a4ea626e5bcefd102d220601b091b12cc">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#a40fc3d72bf602ea777d1e700c234570d">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#acdacbc78cc3cb4d5606f32e326ac72a9">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#a70c8e94fc698fe60a8a81e2fa5f6b3a8">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#a7ca9bb195c07c55fb14a31a5e4e6a6fd">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#aec987add62ce77e3c6507cf2a18720d9">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#ac5b4e84604dfbbb08bcf4ef01a4b85be">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#aff7a47f0f430a862a59032d646a857c1">Lucene.Net.Search.FieldComparator.DocComparator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#adf98ba57f35a666f51cb7f789c7877a1">Lucene.Net.Search.FieldComparator.ByteComparator</a>.</p>
</div>
</div>
<a class="anchor" id="a1b280e1cf1ee223bce3e369fe29ad1c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Search.FieldComparator.SetNextReader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docBase</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>&lt;throws&gt; IOException &lt;/throws&gt; &lt;throws&gt; IOException &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_val_comparator.html#aaaebafebc3f1289d867da1ff77b652f7">Lucene.Net.Search.FieldComparator.StringValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_ord_val_comparator.html#a041d4b4eb2f1979b430288154f53b4cf">Lucene.Net.Search.FieldComparator.StringOrdValComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_string_comparator_locale.html#a9ed66219e996fde68ce01ba3bb021f68">Lucene.Net.Search.FieldComparator.StringComparatorLocale</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_short_comparator.html#a7592353b2df36d40c7313cd8dae82ac6">Lucene.Net.Search.FieldComparator.ShortComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#a26420b79f6155881207a2672f78b0986">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_long_comparator.html#ac1acb25b843d4d3e6a77e0d9d8994500">Lucene.Net.Search.FieldComparator.LongComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_int_comparator.html#a7ec19d89a28b1b9d3269e2fc34e5e511">Lucene.Net.Search.FieldComparator.IntComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_float_comparator.html#ab3b70e243ec330ad157bfcc5c24d39a9">Lucene.Net.Search.FieldComparator.FloatComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_double_comparator.html#a342401893114d19d55c31d771ed6517b">Lucene.Net.Search.FieldComparator.DoubleComparator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_doc_comparator.html#a9cc3555cf6b9474b8dcef7481c2f2b9f">Lucene.Net.Search.FieldComparator.DocComparator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_byte_comparator.html#a0e6374bb87c867626de2d50a192b7aeb">Lucene.Net.Search.FieldComparator.ByteComparator</a>.</p>
</div>
</div>
<a class="anchor" id="abbd2eabb8ea3e83e39ab8af0945abd3a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Search.FieldComparator.SetScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Scorer</a>&#160;</td>
<td class="paramname"><em>scorer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scorer</td><td><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> instance that you should use to obtain the current hit's score, if necessary. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_1_1_relevance_comparator.html#af9debfd79dea19664c82d28fcfebb7ed">Lucene.Net.Search.FieldComparator.RelevanceComparator</a>.</p>
<p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00158">158</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="a5f851ad6bc6a5cdf83ff60c1682ea06f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract IComparable Lucene.Net.Search.FieldComparator.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>Return the actual value in the slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>the value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value in this slot upgraded to Comparable </dd></dl>
<p>Definition at line <a class="el" href="_field_comparator_8cs_source.html#l00171">171</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:56 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>