| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Enum SortFieldType |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Enum SortFieldType |
| | 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.SortFieldType"> |
| |
| |
| <h1 id="Lucene_Net_Search_SortFieldType" data-uid="Lucene.Net.Search.SortFieldType" class="text-break">Enum SortFieldType |
| </h1> |
| <div class="markdown level0 summary"><p>Specifies the type of the terms to be sorted, or special types such as CUSTOM</p> |
| </div> |
| <div class="markdown level0 conceptual"></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_SortFieldType_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public enum SortFieldType</code></pre> |
| </div> |
| <h3 id="fields">Fields |
| </h3> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| <thead> |
| <tbody> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_BYTE">BYTE</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Byte</span>s. Sort values are <span class="xref">System.Byte</span> and |
| lower values are at the front.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_BYTES">BYTES</td> |
| <td><p>Sort use <span class="xref">byte[]</span> index values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_CUSTOM">CUSTOM</td> |
| <td><p>Sort using a custom <span class="xref">System.Collections.Generic.IComparer<T></span>. Sort values are any <span class="xref">System.IComparable<T></span> and |
| sorting is done according to natural order.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_DOC">DOC</td> |
| <td><p>Sort by document number (index order). Sort values are <span class="xref">System.Int32</span> and lower |
| values are at the front.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_DOUBLE">DOUBLE</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Double</span>s. Sort values are <span class="xref">System.Double</span> and |
| lower values are at the front.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_INT16">INT16</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Int16</span>s. Sort values are <span class="xref">System.Int16</span> and |
| lower values are at the front. |
| <p> |
| NOTE: This was SHORT in Lucene</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_INT32">INT32</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Int32</span>s. Sort values are <span class="xref">System.Int32</span> and |
| lower values are at the front. |
| <p> |
| NOTE: This was INT in Lucene</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_INT64">INT64</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Int64</span>s. Sort values are <span class="xref">System.Int64</span> and |
| lower values are at the front. |
| <p> |
| NOTE: This was LONG in Lucene</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_REWRITEABLE">REWRITEABLE</td> |
| <td><p>Force rewriting of <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a> using <a class="xref" href="Lucene.Net.Search.SortField.html#Lucene_Net_Search_SortField_Rewrite_Lucene_Net_Search_IndexSearcher_">Rewrite(IndexSearcher)</a> |
| before it can be used for sorting</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_SCORE">SCORE</td> |
| <td><p>Sort by document score (relevance). Sort values are <span class="xref">System.Single</span> and higher |
| values are at the front.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_SINGLE">SINGLE</td> |
| <td><p>Sort using term values as encoded <span class="xref">System.Single</span>s. Sort values are <span class="xref">System.Single</span> and |
| lower values are at the front. |
| <p> |
| NOTE: This was FLOAT in Lucene</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_STRING">STRING</td> |
| <td><p>Sort using term values as <span class="xref">System.String</span>s. Sort values are <span class="xref">System.String</span>s and lower |
| values are at the front.</p> |
| </td> |
| </tr> |
| <tr> |
| <td id="Lucene_Net_Search_SortFieldType_STRING_VAL">STRING_VAL</td> |
| <td><p>Sort using term values as <span class="xref">System.String</span>s, but comparing by |
| value (using <a class="xref" href="Lucene.Net.Util.BytesRef.html#Lucene_Net_Util_BytesRef_CompareTo_Lucene_Net_Util_BytesRef_">CompareTo(BytesRef)</a>) for all comparisons. |
| this is typically slower than <a class="xref" href="Lucene.Net.Search.SortFieldType.html#Lucene_Net_Search_SortFieldType_STRING">STRING</a>, which |
| uses ordinals to do the sorting.</p> |
| </td> |
| </tr> |
| </tbody> |
| </thead></thead></table> |
| </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_SortFieldType.md&value=---%0Auid%3A%20Lucene.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" 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/#L500" 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> |
