| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SortField |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SortField |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Search.SortField"> |
| |
| |
| <h1 id="Lucene_Net_Search_SortField" data-uid="Lucene.Net.Search.SortField" class="text-break">Class SortField |
| </h1> |
| <div class="markdown level0 summary"><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><p>Created: Feb 11, 2004 1:25:29 PM |
| <p> |
| @since lucene 1.4 </p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">SortField</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_SortField_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SortField</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldCache_IParser_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.FieldCache.IParser)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L116">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldCache_IParser_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.FieldCache.IParser)">SortField(String, FieldCache.IParser)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort by terms in the given field, parsed |
| to numeric values using a custom <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, FieldCache.IParser parser)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by. Must not be <code>null</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a></td> |
| <td><span class="parametername">parser</span></td> |
| <td><p>Instance of a <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a>, |
| which must subclass one of the existing numeric |
| parsers from <a class="xref" href="Lucene.Net.Search.IFieldCache.html">IFieldCache</a>. Sort type is inferred |
| by testing which numeric parser the parser subclasses. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>if the parser fails to |
| subclass an existing numeric parser, or field is <code>null</code> </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldCache_IParser_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.FieldCache.IParser%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldCache_IParser_System_Boolean_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.FieldCache.IParser,System.Boolean)">SortField(String, FieldCache.IParser, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort, possibly in reverse, by terms in the given field, parsed |
| to numeric values using a custom <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, FieldCache.IParser parser, bool reverse)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by. Must not be <code>null</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a></td> |
| <td><span class="parametername">parser</span></td> |
| <td><p>Instance of a <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a>, |
| which must subclass one of the existing numeric |
| parsers from <a class="xref" href="Lucene.Net.Search.IFieldCache.html">IFieldCache</a>. Sort type is inferred |
| by testing which numeric parser the parser subclasses. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">reverse</span></td> |
| <td><p><code>True</code> if natural order should be reversed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>if the parser fails to |
| subclass an existing numeric parser, or field is <code>null</code> </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldComparerSource_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.FieldComparerSource)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L226">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldComparerSource_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.FieldComparerSource)">SortField(String, FieldComparerSource)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort with a custom comparison function. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, FieldComparerSource comparer)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by; cannot be <code>null</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a></td> |
| <td><span class="parametername">comparer</span></td> |
| <td><p>Returns a comparer for sorting hits. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldComparerSource_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.FieldComparerSource%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L237">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_FieldComparerSource_System_Boolean_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.FieldComparerSource,System.Boolean)">SortField(String, FieldComparerSource, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort, possibly in reverse, with a custom comparison function. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, FieldComparerSource comparer, bool reverse)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by; cannot be <code>null</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a></td> |
| <td><span class="parametername">comparer</span></td> |
| <td><p>Returns a comparer for sorting hits. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">reverse</span></td> |
| <td><p><code>True</code> if natural order should be reversed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_SortFieldType_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.SortFieldType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L88">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_SortFieldType_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.SortFieldType)">SortField(String, SortFieldType)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort by terms in the given field with the type of term |
| values explicitly given. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, SortFieldType type)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by. Can be <code>null</code> if |
| <code data-dev-comment-type="paramref" class="paramref">type</code> is <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_SCORE">SCORE</a> or <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_DOC">DOC</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortFieldType.html">SortFieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>Type of values in the terms. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_SortFieldType_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.%23ctor(System.String%2CLucene.Net.Search.SortFieldType%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L100">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField__ctor_" data-uid="Lucene.Net.Search.SortField.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_SortField__ctor_System_String_Lucene_Net_Search_SortFieldType_System_Boolean_" data-uid="Lucene.Net.Search.SortField.#ctor(System.String,Lucene.Net.Search.SortFieldType,System.Boolean)">SortField(String, SortFieldType, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a sort, possibly in reverse, by terms in the given field with the |
| type of term values explicitly given. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField(string field, SortFieldType type, bool reverse)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>Name of field to sort by. Can be <code>null</code> if |
| <code data-dev-comment-type="paramref" class="paramref">type</code> is <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_SCORE">SCORE</a> or <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_DOC">DOC</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortFieldType.html">SortFieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>Type of values in the terms. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">reverse</span></td> |
| <td><p><code>True</code> if natural order should be reversed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_FIELD_DOC.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.FIELD_DOC%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L47">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_SortField_FIELD_DOC" data-uid="Lucene.Net.Search.SortField.FIELD_DOC">FIELD_DOC</h4> |
| <div class="markdown level1 summary"><p>Represents sorting by document number (index order). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly SortField FIELD_DOC</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_FIELD_SCORE.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.FIELD_SCORE%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L43">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_SortField_FIELD_SCORE" data-uid="Lucene.Net.Search.SortField.FIELD_SCORE">FIELD_SCORE</h4> |
| <div class="markdown level1 summary"><p>Represents sorting by document score (relevance). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly SortField FIELD_SCORE</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_m_missingValue.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.m_missingValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L80">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_SortField_m_missingValue" data-uid="Lucene.Net.Search.SortField.m_missingValue">m_missingValue</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected object m_missingValue</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_STRING_FIRST.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.STRING_FIRST%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L173">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_SortField_STRING_FIRST" data-uid="Lucene.Net.Search.SortField.STRING_FIRST">STRING_FIRST</h4> |
| <div class="markdown level1 summary"><p>Pass this to <a class="xref" href="Lucene.Net.Search.SortField.html#Lucene_Net_Search_SortField_MissingValue">MissingValue</a> to have missing |
| string values sort first.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly object STRING_FIRST</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_STRING_LAST.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.STRING_LAST%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L191">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_SortField_STRING_LAST" data-uid="Lucene.Net.Search.SortField.STRING_LAST">STRING_LAST</h4> |
| <div class="markdown level1 summary"><p>Pass this to <a class="xref" href="Lucene.Net.Search.SortField.html#Lucene_Net_Search_SortField_MissingValue">MissingValue</a> to have missing |
| string values sort last.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly object STRING_LAST</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_BytesComparer.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.BytesComparer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L410">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_BytesComparer_" data-uid="Lucene.Net.Search.SortField.BytesComparer*"></a> |
| <h4 id="Lucene_Net_Search_SortField_BytesComparer" data-uid="Lucene.Net.Search.SortField.BytesComparer">BytesComparer</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IComparer<BytesRef> BytesComparer { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IComparer</span><<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_ComparerSource.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.ComparerSource%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L289">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_ComparerSource_" data-uid="Lucene.Net.Search.SortField.ComparerSource*"></a> |
| <h4 id="Lucene_Net_Search_SortField_ComparerSource" data-uid="Lucene.Net.Search.SortField.ComparerSource">ComparerSource</h4> |
| <div class="markdown level1 summary"><p>Returns the <a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a> used for |
| custom sorting.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FieldComparerSource ComparerSource { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_Field.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.Field%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L266">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_Field_" data-uid="Lucene.Net.Search.SortField.Field*"></a> |
| <h4 id="Lucene_Net_Search_SortField_Field" data-uid="Lucene.Net.Search.SortField.Field">Field</h4> |
| <div class="markdown level1 summary"><p>Returns the name of the field. Could return <code>null</code> |
| if the sort is by <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_SCORE">SCORE</a> or <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_DOC">DOC</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Field { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>Name of field, possibly <code>null</code>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_IsReverse.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.IsReverse%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L283">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_IsReverse_" data-uid="Lucene.Net.Search.SortField.IsReverse*"></a> |
| <h4 id="Lucene_Net_Search_SortField_IsReverse" data-uid="Lucene.Net.Search.SortField.IsReverse">IsReverse</h4> |
| <div class="markdown level1 summary"><p>Returns whether the sort should be reversed. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsReverse { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p><code>True</code> if natural order should be reversed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_MissingValue.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.MissingValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_MissingValue_" data-uid="Lucene.Net.Search.SortField.MissingValue*"></a> |
| <h4 id="Lucene_Net_Search_SortField_MissingValue" data-uid="Lucene.Net.Search.SortField.MissingValue">MissingValue</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual object MissingValue { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_NeedsScores.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.NeedsScores%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L494">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_NeedsScores_" data-uid="Lucene.Net.Search.SortField.NeedsScores*"></a> |
| <h4 id="Lucene_Net_Search_SortField_NeedsScores" data-uid="Lucene.Net.Search.SortField.NeedsScores">NeedsScores</h4> |
| <div class="markdown level1 summary"><p>Whether the relevance score is needed to sort documents. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool NeedsScores { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_Parser.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.Parser%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L278">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_Parser_" data-uid="Lucene.Net.Search.SortField.Parser*"></a> |
| <h4 id="Lucene_Net_Search_SortField_Parser" data-uid="Lucene.Net.Search.SortField.Parser">Parser</h4> |
| <div class="markdown level1 summary"><p>Returns the instance of a <a class="xref" href="Lucene.Net.Search.IFieldCache.html">IFieldCache</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> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FieldCache.IParser Parser { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a></td> |
| <td><p>An instance of a <a class="xref" href="Lucene.Net.Search.IFieldCache.html">IFieldCache</a> parser, or <code>null</code>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_Type.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.Type%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L272">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_Type_" data-uid="Lucene.Net.Search.SortField.Type*"></a> |
| <h4 id="Lucene_Net_Search_SortField_Type" data-uid="Lucene.Net.Search.SortField.Type">Type</h4> |
| <div class="markdown level1 summary"><p>Returns the type of contents in the field. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual SortFieldType Type { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortFieldType.html">SortFieldType</a></td> |
| <td><p>One of <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_SCORE">SCORE</a>, <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_DOC">DOC</a>, |
| <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_STRING">STRING</a>, <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_INT32">INT32</a> or <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_SINGLE">SINGLE</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_Equals_System_Object_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.Equals(System.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L370">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_Equals_" data-uid="Lucene.Net.Search.SortField.Equals*"></a> |
| <h4 id="Lucene_Net_Search_SortField_Equals_System_Object_" data-uid="Lucene.Net.Search.SortField.Equals(System.Object)">Equals(Object)</h4> |
| <div class="markdown level1 summary"><p>Returns <code>true</code> if <code data-dev-comment-type="paramref" class="paramref">o</code> is equal to this. If a |
| <a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a> or |
| <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a> was provided, it must properly |
| implement equals (unless a singleton is always used).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool Equals(object o)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td><span class="parametername">o</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.Equals(System.Object)</span></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_GetComparer_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.GetComparer(System.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L428">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_GetComparer_" data-uid="Lucene.Net.Search.SortField.GetComparer*"></a> |
| <h4 id="Lucene_Net_Search_SortField_GetComparer_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.SortField.GetComparer(System.Int32,System.Int32)">GetComparer(Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the <a class="xref" href="Lucene.Net.Search.FieldComparer.html">FieldComparer</a> to use for |
| sorting. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FieldComparer GetComparer(int numHits, int sortPos)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numHits</span></td> |
| <td><p>Number of top hits the queue will store </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">sortPos</span></td> |
| <td><p>Position of this <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a> within |
| <a class="xref" href="Lucene.Net.Search.Sort.html">Sort</a>. The comparer is primary if sortPos==0, |
| secondary if sortPos==1, etc. Some comparers can |
| optimize themselves when they are the primary sort. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldComparer.html">FieldComparer</a></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.FieldComparer.html">FieldComparer</a> to use when sorting </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_GetHashCode.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.GetHashCode%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L394">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_GetHashCode_" data-uid="Lucene.Net.Search.SortField.GetHashCode*"></a> |
| <h4 id="Lucene_Net_Search_SortField_GetHashCode" data-uid="Lucene.Net.Search.SortField.GetHashCode">GetHashCode()</h4> |
| <div class="markdown level1 summary"><p>Returns a hash code value for this object. If a |
| <a class="xref" href="Lucene.Net.Search.FieldComparerSource.html">FieldComparerSource</a> or |
| <a class="xref" href="Lucene.Net.Search.FieldCache.IParser.html">FieldCache.IParser</a> was provided, it must properly |
| implement GetHashCode() (unless a singleton is always |
| used).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.GetHashCode()</span></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_Rewrite_Lucene_Net_Search_IndexSearcher_.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.Rewrite(Lucene.Net.Search.IndexSearcher)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L487">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_Rewrite_" data-uid="Lucene.Net.Search.SortField.Rewrite*"></a> |
| <h4 id="Lucene_Net_Search_SortField_Rewrite_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Search.SortField.Rewrite(Lucene.Net.Search.IndexSearcher)">Rewrite(IndexSearcher)</h4> |
| <div class="markdown level1 summary"><p>Rewrites this <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a>, returning a new <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a> if a change is made. |
| Subclasses should override this define their rewriting behavior when this |
| SortField is of type <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_REWRITEABLE">REWRITEABLE</a>. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual SortField Rewrite(IndexSearcher searcher)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a> to use during rewriting </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a></td> |
| <td><p>New rewritten <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a>, or <code>this</code> if nothing has changed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>Can be thrown by the rewriting </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField_ToString.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L291">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_SortField_ToString_" data-uid="Lucene.Net.Search.SortField.ToString*"></a> |
| <h4 id="Lucene_Net_Search_SortField_ToString" data-uid="Lucene.Net.Search.SortField.ToString">ToString()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string ToString()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</span></div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.Sort.html">Sort</a></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_SortField.md&value=---%0Auid%3A%20Lucene.Net.Search.SortField%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Search/SortField.cs/#L37" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
