blob: 5f7f9f3064f1834fbaef117aab6fd84c5674bb97 [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.SortField 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_sort_field.html">SortField</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_sort_field-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.SortField Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Stores information about how to sort documents by terms in an individual field. Fields must be indexed in order to sort by them.
<a href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#details">More...</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:a08e5ec1055d2f9066daa5a00a84274c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a08e5ec1055d2f9066daa5a00a84274c4">SortField</a> (System.String field, int type)</td></tr>
<tr class="memdesc:a08e5ec1055d2f9066daa5a00a84274c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort by terms in the given field with the type of term values explicitly given. <a href="#a08e5ec1055d2f9066daa5a00a84274c4"></a><br/></td></tr>
<tr class="separator:a08e5ec1055d2f9066daa5a00a84274c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d5c3002bb4dc2787cb74d04c13cc86a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a2d5c3002bb4dc2787cb74d04c13cc86a">SortField</a> (System.String field, int type, bool reverse)</td></tr>
<tr class="memdesc:a2d5c3002bb4dc2787cb74d04c13cc86a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort, possibly in reverse, by terms in the given field with the type of term values explicitly given. <a href="#a2d5c3002bb4dc2787cb74d04c13cc86a"></a><br/></td></tr>
<tr class="separator:a2d5c3002bb4dc2787cb74d04c13cc86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb8d7eeeaf9d45f2da53dd9252c20ad8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#acb8d7eeeaf9d45f2da53dd9252c20ad8">SortField</a> (System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Lucene.Net.Search.Parser</a> parser)</td></tr>
<tr class="memdesc:acb8d7eeeaf9d45f2da53dd9252c20ad8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort by terms in the given field, parsed to numeric values using a custom <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>. <a href="#acb8d7eeeaf9d45f2da53dd9252c20ad8"></a><br/></td></tr>
<tr class="separator:acb8d7eeeaf9d45f2da53dd9252c20ad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86fb2a099f36e053eeaca9f8c0228195"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a86fb2a099f36e053eeaca9f8c0228195">SortField</a> (System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Lucene.Net.Search.Parser</a> parser, bool reverse)</td></tr>
<tr class="memdesc:a86fb2a099f36e053eeaca9f8c0228195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort, possibly in reverse, by terms in the given field, parsed to numeric values using a custom <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>. <a href="#a86fb2a099f36e053eeaca9f8c0228195"></a><br/></td></tr>
<tr class="separator:a86fb2a099f36e053eeaca9f8c0228195"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26d706f5c6ad91e59fe4e602798a180b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a26d706f5c6ad91e59fe4e602798a180b">SortField</a> (System.String field, System.Globalization.CultureInfo locale)</td></tr>
<tr class="memdesc:a26d706f5c6ad91e59fe4e602798a180b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort by terms in the given field sorted according to the given locale. <a href="#a26d706f5c6ad91e59fe4e602798a180b"></a><br/></td></tr>
<tr class="separator:a26d706f5c6ad91e59fe4e602798a180b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27e76622c14eeab697a07f4f88a46511"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a27e76622c14eeab697a07f4f88a46511">SortField</a> (System.String field, System.Globalization.CultureInfo locale, bool reverse)</td></tr>
<tr class="memdesc:a27e76622c14eeab697a07f4f88a46511"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort, possibly in reverse, by terms in the given field sorted according to the given locale. <a href="#a27e76622c14eeab697a07f4f88a46511"></a><br/></td></tr>
<tr class="separator:a27e76622c14eeab697a07f4f88a46511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9de5e6a4b68f3ccda134662576b5e536"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a9de5e6a4b68f3ccda134662576b5e536">SortField</a> (System.String field, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html">FieldComparatorSource</a> comparator)</td></tr>
<tr class="memdesc:a9de5e6a4b68f3ccda134662576b5e536"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort with a custom comparison function. <a href="#a9de5e6a4b68f3ccda134662576b5e536"></a><br/></td></tr>
<tr class="separator:a9de5e6a4b68f3ccda134662576b5e536"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6d451a413e7a5a61a01bead7fc19196"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#aa6d451a413e7a5a61a01bead7fc19196">SortField</a> (System.String field, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html">FieldComparatorSource</a> comparator, bool reverse)</td></tr>
<tr class="memdesc:aa6d451a413e7a5a61a01bead7fc19196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a sort, possibly in reverse, with a custom comparison function. <a href="#aa6d451a413e7a5a61a01bead7fc19196"></a><br/></td></tr>
<tr class="separator:aa6d451a413e7a5a61a01bead7fc19196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a696b294698ead310e82123f1c888624d"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a696b294698ead310e82123f1c888624d">ToString</a> ()</td></tr>
<tr class="separator:a696b294698ead310e82123f1c888624d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4213b043034004c66fba158a4a17381"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ad4213b043034004c66fba158a4a17381">Equals</a> (System.Object o)</td></tr>
<tr class="memdesc:ad4213b043034004c66fba158a4a17381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <code>o</code> is equal to this. If a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> or <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a> was provided, it must properly implement equals (unless a singleton is always used). <a href="#ad4213b043034004c66fba158a4a17381"></a><br/></td></tr>
<tr class="separator:ad4213b043034004c66fba158a4a17381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea08d376221c14a66e61bda3566851c4"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#aea08d376221c14a66e61bda3566851c4">GetHashCode</a> ()</td></tr>
<tr class="memdesc:aea08d376221c14a66e61bda3566851c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <code>o</code> is equal to this. If a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> (deprecated) or <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a> was provided, it must properly implement hashCode (unless a singleton is always used). <a href="#aea08d376221c14a66e61bda3566851c4"></a><br/></td></tr>
<tr class="separator:aea08d376221c14a66e61bda3566851c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae452450eb9bd2156f3fc6da3ccf26780"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">FieldComparator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ae452450eb9bd2156f3fc6da3ccf26780">GetComparator</a> (int numHits, int sortPos)</td></tr>
<tr class="memdesc:ae452450eb9bd2156f3fc6da3ccf26780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns 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> to use for sorting. <a href="#ae452450eb9bd2156f3fc6da3ccf26780"></a><br/></td></tr>
<tr class="separator:ae452450eb9bd2156f3fc6da3ccf26780"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ace797bc623a0b91b213019f782d95eee"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ace797bc623a0b91b213019f782d95eee">SCORE</a> = 0</td></tr>
<tr class="memdesc:ace797bc623a0b91b213019f782d95eee"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> by document score (relevancy). <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> values are Float and higher values are at the front. <a href="#ace797bc623a0b91b213019f782d95eee"></a><br/></td></tr>
<tr class="separator:ace797bc623a0b91b213019f782d95eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad64ef3fbe6823fd86240083cce17d787"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ad64ef3fbe6823fd86240083cce17d787">DOC</a> = 1</td></tr>
<tr class="memdesc:ad64ef3fbe6823fd86240083cce17d787"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> by document number (index order). <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> values are Integer and lower values are at the front. <a href="#ad64ef3fbe6823fd86240083cce17d787"></a><br/></td></tr>
<tr class="separator:ad64ef3fbe6823fd86240083cce17d787"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb7c6bb38df95cf2e42982060a8c5072"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#acb7c6bb38df95cf2e42982060a8c5072">STRING</a> = 3</td></tr>
<tr class="memdesc:acb7c6bb38df95cf2e42982060a8c5072"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as Strings. <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> values are String and lower values are at the front. <a href="#acb7c6bb38df95cf2e42982060a8c5072"></a><br/></td></tr>
<tr class="separator:acb7c6bb38df95cf2e42982060a8c5072"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65ce58b6d75a00f7b64282fdc93cdaaf"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a65ce58b6d75a00f7b64282fdc93cdaaf">INT</a> = 4</td></tr>
<tr class="memdesc:a65ce58b6d75a00f7b64282fdc93cdaaf"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Integers. <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> values are Integer and lower values are at the front. <a href="#a65ce58b6d75a00f7b64282fdc93cdaaf"></a><br/></td></tr>
<tr class="separator:a65ce58b6d75a00f7b64282fdc93cdaaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeda8d058ac57d3c717d48bd5145cc359"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#aeda8d058ac57d3c717d48bd5145cc359">FLOAT</a> = 5</td></tr>
<tr class="memdesc:aeda8d058ac57d3c717d48bd5145cc359"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Floats. <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> values are Float and lower values are at the front. <a href="#aeda8d058ac57d3c717d48bd5145cc359"></a><br/></td></tr>
<tr class="separator:aeda8d058ac57d3c717d48bd5145cc359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49d934305468e3ab96afdca801e516df"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a49d934305468e3ab96afdca801e516df">LONG</a> = 6</td></tr>
<tr class="memdesc:a49d934305468e3ab96afdca801e516df"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Longs. <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> values are Long and lower values are at the front. <a href="#a49d934305468e3ab96afdca801e516df"></a><br/></td></tr>
<tr class="separator:a49d934305468e3ab96afdca801e516df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14e968f73877b94686629ceb1cefa78b"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a14e968f73877b94686629ceb1cefa78b">DOUBLE</a> = 7</td></tr>
<tr class="memdesc:a14e968f73877b94686629ceb1cefa78b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Doubles. <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> values are Double and lower values are at the front. <a href="#a14e968f73877b94686629ceb1cefa78b"></a><br/></td></tr>
<tr class="separator:a14e968f73877b94686629ceb1cefa78b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e25f247e74537a488e19d3a65278d34"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a1e25f247e74537a488e19d3a65278d34">SHORT</a> = 8</td></tr>
<tr class="memdesc:a1e25f247e74537a488e19d3a65278d34"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Shorts. <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> values are Short and lower values are at the front. <a href="#a1e25f247e74537a488e19d3a65278d34"></a><br/></td></tr>
<tr class="separator:a1e25f247e74537a488e19d3a65278d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bdc5e6cac11de1b38647ee50f6e7032"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a6bdc5e6cac11de1b38647ee50f6e7032">CUSTOM</a> = 9</td></tr>
<tr class="memdesc:a6bdc5e6cac11de1b38647ee50f6e7032"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using a custom Comparator. <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> values are any Comparable and sorting is done according to natural order. <a href="#a6bdc5e6cac11de1b38647ee50f6e7032"></a><br/></td></tr>
<tr class="separator:a6bdc5e6cac11de1b38647ee50f6e7032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab69f245310d1ac4681fe10711fab79b2"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ab69f245310d1ac4681fe10711fab79b2">BYTE</a> = 10</td></tr>
<tr class="memdesc:ab69f245310d1ac4681fe10711fab79b2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as encoded Bytes. <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> values are Byte and lower values are at the front. <a href="#ab69f245310d1ac4681fe10711fab79b2"></a><br/></td></tr>
<tr class="separator:ab69f245310d1ac4681fe10711fab79b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32c2ac3454cc03daa93c0ed8305f23e0"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a32c2ac3454cc03daa93c0ed8305f23e0">STRING_VAL</a> = 11</td></tr>
<tr class="memdesc:a32c2ac3454cc03daa93c0ed8305f23e0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> using term values as Strings, but comparing by value (using String.compareTo) for all comparisons. This is typically slower than <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#acb7c6bb38df95cf2e42982060a8c5072" title="Sort using term values as Strings. Sort values are String and lower values are at the front...">STRING</a>, which uses ordinals to do the sorting. <a href="#a32c2ac3454cc03daa93c0ed8305f23e0"></a><br/></td></tr>
<tr class="separator:a32c2ac3454cc03daa93c0ed8305f23e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a2e00ce779e9cb9e367ccb103f50dcc04"><td class="memItemLeft" align="right" valign="top">static readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a2e00ce779e9cb9e367ccb103f50dcc04">FIELD_SCORE</a> = new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>(null, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ace797bc623a0b91b213019f782d95eee">SCORE</a>)</td></tr>
<tr class="memdesc:a2e00ce779e9cb9e367ccb103f50dcc04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents sorting by document score (relevancy). <a href="#a2e00ce779e9cb9e367ccb103f50dcc04"></a><br/></td></tr>
<tr class="separator:a2e00ce779e9cb9e367ccb103f50dcc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf5ecd4d47b6e6e2eb3827f1b0164e25"><td class="memItemLeft" align="right" valign="top">static readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#abf5ecd4d47b6e6e2eb3827f1b0164e25">FIELD_DOC</a> = new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>(null, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ad64ef3fbe6823fd86240083cce17d787">DOC</a>)</td></tr>
<tr class="memdesc:abf5ecd4d47b6e6e2eb3827f1b0164e25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents sorting by document number (index order). <a href="#abf5ecd4d47b6e6e2eb3827f1b0164e25"></a><br/></td></tr>
<tr class="separator:abf5ecd4d47b6e6e2eb3827f1b0164e25"><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:ae5fc31683f40734a65675f114b22fa8a"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ae5fc31683f40734a65675f114b22fa8a">Field</a><code> [get]</code></td></tr>
<tr class="memdesc:ae5fc31683f40734a65675f114b22fa8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the field. Could return <code>null</code> if the sort is by SCORE or DOC. <a href="#ae5fc31683f40734a65675f114b22fa8a"></a><br/></td></tr>
<tr class="separator:ae5fc31683f40734a65675f114b22fa8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e11686ac735f3d1dfe94c801894df40"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a4e11686ac735f3d1dfe94c801894df40">Type</a><code> [get]</code></td></tr>
<tr class="memdesc:a4e11686ac735f3d1dfe94c801894df40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of contents in the field. <a href="#a4e11686ac735f3d1dfe94c801894df40"></a><br/></td></tr>
<tr class="separator:a4e11686ac735f3d1dfe94c801894df40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50e2dd4788878515e1c8be85845b86b0"><td class="memItemLeft" align="right" valign="top">virtual CultureInfo&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a50e2dd4788878515e1c8be85845b86b0">Locale</a><code> [get]</code></td></tr>
<tr class="memdesc:a50e2dd4788878515e1c8be85845b86b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Locale by which term values are interpreted. May return <code>null</code> if no Locale was specified. <a href="#a50e2dd4788878515e1c8be85845b86b0"></a><br/></td></tr>
<tr class="separator:a50e2dd4788878515e1c8be85845b86b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6769bbf48def8d1801e2ed76a3bbc96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Parser</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#af6769bbf48def8d1801e2ed76a3bbc96">Parser</a><code> [get]</code></td></tr>
<tr class="memdesc:af6769bbf48def8d1801e2ed76a3bbc96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the instance of a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> parser that fits to the given sort type. May return <code>null</code> if no parser was specified. Sorting is using the default parser then. <a href="#af6769bbf48def8d1801e2ed76a3bbc96"></a><br/></td></tr>
<tr class="separator:af6769bbf48def8d1801e2ed76a3bbc96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf5347331638d53be8734bca8e96e701"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#adf5347331638d53be8734bca8e96e701">Reverse</a><code> [get]</code></td></tr>
<tr class="memdesc:adf5347331638d53be8734bca8e96e701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the sort should be reversed. <a href="#adf5347331638d53be8734bca8e96e701"></a><br/></td></tr>
<tr class="separator:adf5347331638d53be8734bca8e96e701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43c61145d5ede9a4cc352fc964a38083"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html">FieldComparatorSource</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#a43c61145d5ede9a4cc352fc964a38083">ComparatorSource</a><code> [get]</code></td></tr>
<tr class="memdesc:a43c61145d5ede9a4cc352fc964a38083"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> used for custom sorting <a href="#a43c61145d5ede9a4cc352fc964a38083"></a><br/></td></tr>
<tr class="separator:a43c61145d5ede9a4cc352fc964a38083"><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>Stores information about how to sort documents by terms in an individual field. Fields must be indexed in order to sort by them. </p>
<p>Created: Feb 11, 2004 1:25:29 PM </p>
<dl class="section see"><dt>See Also</dt><dd><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></dd></dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00038">38</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a08e5ec1055d2f9066daa5a00a84274c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort by terms in the given field with the type of term values explicitly given. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by. Can be <code>null</code> if <code>type</code> is SCORE or DOC. </td></tr>
<tr><td class="paramname">type</td><td>Type of values in the terms. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00126">126</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2d5c3002bb4dc2787cb74d04c13cc86a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>reverse</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort, possibly in reverse, by terms in the given field with the type of term values explicitly given. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by. Can be <code>null</code> if <code>type</code> is SCORE or DOC. </td></tr>
<tr><td class="paramname">type</td><td>Type of values in the terms. </td></tr>
<tr><td class="paramname">reverse</td><td>True if natural order should be reversed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00141">141</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acb8d7eeeaf9d45f2da53dd9252c20ad8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Lucene.Net.Search.Parser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort by terms in the given field, parsed to numeric values using a custom <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by. Must not be null. </td></tr>
<tr><td class="paramname">parser</td><td>Instance of a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>, which must subclass one of the existing numeric parsers from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. <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> type is inferred by testing which numeric parser the parser subclasses. </td></tr>
</table>
</dd>
</dl>
<p>&lt;throws&gt; IllegalArgumentException if the parser fails to &lt;/throws&gt; </p>
<p>subclass an existing numeric parser, or field is null </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00160">160</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a86fb2a099f36e053eeaca9f8c0228195"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Lucene.Net.Search.Parser</a>&#160;</td>
<td class="paramname"><em>parser</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>reverse</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort, possibly in reverse, by terms in the given field, parsed to numeric values using a custom <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by. Must not be null. </td></tr>
<tr><td class="paramname">parser</td><td>Instance of a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a>, which must subclass one of the existing numeric parsers from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. <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> type is inferred by testing which numeric parser the parser subclasses. </td></tr>
<tr><td class="paramname">reverse</td><td>True if natural order should be reversed. </td></tr>
</table>
</dd>
</dl>
<p>&lt;throws&gt; IllegalArgumentException if the parser fails to &lt;/throws&gt; </p>
<p>subclass an existing numeric parser, or field is null </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00179">179</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a26d706f5c6ad91e59fe4e602798a180b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.Globalization.CultureInfo&#160;</td>
<td class="paramname"><em>locale</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort by terms in the given field sorted according to the given locale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by, cannot be <code>null</code>. </td></tr>
<tr><td class="paramname">locale</td><td>Locale of values in the field. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00209">209</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a27e76622c14eeab697a07f4f88a46511"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.Globalization.CultureInfo&#160;</td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>reverse</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort, possibly in reverse, by terms in the given field sorted according to the given locale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by, cannot be <code>null</code>. </td></tr>
<tr><td class="paramname">locale</td><td>Locale of values in the field. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00222">222</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9de5e6a4b68f3ccda134662576b5e536"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</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_field_comparator_source.html">FieldComparatorSource</a>&#160;</td>
<td class="paramname"><em>comparator</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort with a custom comparison function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by; cannot be <code>null</code>. </td></tr>
<tr><td class="paramname">comparator</td><td>Returns a comparator for sorting hits. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00234">234</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa6d451a413e7a5a61a01bead7fc19196"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.SortField.SortField </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</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_field_comparator_source.html">FieldComparatorSource</a>&#160;</td>
<td class="paramname"><em>comparator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>reverse</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a sort, possibly in reverse, with a custom comparison function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Name of field to sort by; cannot be <code>null</code>. </td></tr>
<tr><td class="paramname">comparator</td><td>Returns a comparator for sorting hits. </td></tr>
<tr><td class="paramname">reverse</td><td>True if natural order should be reversed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00247">247</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad4213b043034004c66fba158a4a17381"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.SortField.Equals </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if <code>o</code> is equal to this. If a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> or <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a> was provided, it must properly implement equals (unless a singleton is always used). </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00391">391</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae452450eb9bd2156f3fc6da3ccf26780"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator.html">FieldComparator</a> Lucene.Net.Search.SortField.GetComparator </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>numHits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sortPos</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns 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> to use for sorting. </p>
<p><b>NOTE:</b> This API is experimental and might change in incompatible ways in the next release.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numHits</td><td>number of top hits the queue will store </td></tr>
<tr><td class="paramname">sortPos</td><td>position of this <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> within <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> . The comparator is primary if sortPos==0, secondary if sortPos==1, etc. Some comparators can optimize themselves when they are the primary sort. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><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> to use when sorting </dd></dl>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00459">459</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aea08d376221c14a66e61bda3566851c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.SortField.GetHashCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if <code>o</code> is equal to this. If a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> (deprecated) or <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html" title="Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...">Search.Parser</a> was provided, it must properly implement hashCode (unless a singleton is always used). </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00413">413</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a696b294698ead310e82123f1c888624d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Search.SortField.ToString </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="_sort_field_8cs_source.html#l00320">320</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab69f245310d1ac4681fe10711fab79b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.BYTE = 10</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Bytes. <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> values are Byte and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00090">90</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6bdc5e6cac11de1b38647ee50f6e7032"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.CUSTOM = 9</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using a custom Comparator. <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> values are any Comparable and sorting is done according to natural order. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00085">85</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad64ef3fbe6823fd86240083cce17d787"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.DOC = 1</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> by document number (index order). <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> values are Integer and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00048">48</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a14e968f73877b94686629ceb1cefa78b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.DOUBLE = 7</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Doubles. <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> values are Double and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00075">75</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abf5ecd4d47b6e6e2eb3827f1b0164e25"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a> Lucene.Net.Search.SortField.FIELD_DOC = new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>(null, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ad64ef3fbe6823fd86240083cce17d787">DOC</a>)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Represents sorting by document number (index order). </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00107">107</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2e00ce779e9cb9e367ccb103f50dcc04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a> Lucene.Net.Search.SortField.FIELD_SCORE = new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html">SortField</a>(null, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#ace797bc623a0b91b213019f782d95eee">SCORE</a>)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Represents sorting by document score (relevancy). </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00104">104</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aeda8d058ac57d3c717d48bd5145cc359"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.FLOAT = 5</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Floats. <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> values are Float and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00065">65</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a65ce58b6d75a00f7b64282fdc93cdaaf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.INT = 4</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Integers. <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> values are Integer and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00060">60</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a49d934305468e3ab96afdca801e516df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.LONG = 6</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Longs. <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> values are Long and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00070">70</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ace797bc623a0b91b213019f782d95eee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.SCORE = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> by document score (relevancy). <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> values are Float and higher values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00043">43</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a1e25f247e74537a488e19d3a65278d34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.SHORT = 8</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as encoded Shorts. <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> values are Short and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00080">80</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acb7c6bb38df95cf2e42982060a8c5072"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.STRING = 3</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as Strings. <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> values are String and lower values are at the front. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00055">55</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a32c2ac3454cc03daa93c0ed8305f23e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Lucene.Net.Search.SortField.STRING_VAL = 11</td>
</tr>
</table>
</div><div class="memdoc">
<p><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> using term values as Strings, but comparing by value (using String.compareTo) for all comparisons. This is typically slower than <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort_field.html#acb7c6bb38df95cf2e42982060a8c5072" title="Sort using term values as Strings. Sort values are String and lower values are at the front...">STRING</a>, which uses ordinals to do the sorting. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00097">97</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a43c61145d5ede9a4cc352fc964a38083"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html">FieldComparatorSource</a> Lucene.Net.Search.SortField.ComparatorSource</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>Returns the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_comparator_source.html" title="Provides a FieldComparator for custom field sorting.">FieldComparatorSource</a> used for custom sorting </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00316">316</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae5fc31683f40734a65675f114b22fa8a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual string Lucene.Net.Search.SortField.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>Returns the name of the field. Could return <code>null</code> if the sort is by SCORE or DOC. </p>
<p>Name of field, possibly &lt;c&gt;null&lt;/c&gt;. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00275">275</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a50e2dd4788878515e1c8be85845b86b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CultureInfo Lucene.Net.Search.SortField.Locale</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>Returns the Locale by which term values are interpreted. May return <code>null</code> if no Locale was specified. </p>
<p>Locale, or &lt;c&gt;null&lt;/c&gt;. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00291">291</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af6769bbf48def8d1801e2ed76a3bbc96"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_parser.html">Parser</a> Lucene.Net.Search.SortField.Parser</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>Returns the instance of a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> parser that fits to the given sort type. May return <code>null</code> if no parser was specified. Sorting is using the default parser then. </p>
<p>An instance of a &lt;see cref="<a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>" /&gt; parser, or &lt;c&gt;null&lt;/c&gt;. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00300">300</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="adf5347331638d53be8734bca8e96e701"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Search.SortField.Reverse</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>Returns whether the sort should be reversed.</p>
<p>True if natural order should be reversed. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00307">307</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4e11686ac735f3d1dfe94c801894df40"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Lucene.Net.Search.SortField.Type</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>Returns the type of contents in the field.</p>
<p>One of the constants SCORE, DOC, STRING, INT or FLOAT. </p>
<p>Definition at line <a class="el" href="_sort_field_8cs_source.html#l00282">282</a> of file <a class="el" href="_sort_field_8cs_source.html">SortField.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="_sort_field_8cs_source.html">SortField.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:57 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>