| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface ITopDocsCollector |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface ITopDocsCollector |
| | 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.ITopDocsCollector"> |
| |
| |
| <h1 id="Lucene_Net_Search_ITopDocsCollector" data-uid="Lucene.Net.Search.ITopDocsCollector" class="text-break">Interface ITopDocsCollector |
| </h1> |
| <div class="markdown level0 summary"><p>LUCENENET specific interface used to reference <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html">TopDocsCollector<T></a> |
| without referencing its generic type.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_SetScorer_Lucene_Net_Search_Scorer_">ICollector.SetScorer(Scorer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_Collect_System_Int32_">ICollector.Collect(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_">ICollector.SetNextReader(AtomicReaderContext)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_AcceptsDocsOutOfOrder">ICollector.AcceptsDocsOutOfOrder</a> |
| </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_ITopDocsCollector_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface ITopDocsCollector : ICollector</code></pre> |
| </div> |
| <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_ITopDocsCollector_TotalHits.md&value=---%0Auid%3A%20Lucene.Net.Search.ITopDocsCollector.TotalHits%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/TopDocsCollector.cs/#L251">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ITopDocsCollector_TotalHits_" data-uid="Lucene.Net.Search.ITopDocsCollector.TotalHits*"></a> |
| <h4 id="Lucene_Net_Search_ITopDocsCollector_TotalHits" data-uid="Lucene.Net.Search.ITopDocsCollector.TotalHits">TotalHits</h4> |
| <div class="markdown level1 summary"><p>The total number of documents that matched this query. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int TotalHits { 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.Int32</span></td> |
| <td></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_ITopDocsCollector_GetTopDocs.md&value=---%0Auid%3A%20Lucene.Net.Search.ITopDocsCollector.GetTopDocs%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/TopDocsCollector.cs/#L255">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs_" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs*"></a> |
| <h4 id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs">GetTopDocs()</h4> |
| <div class="markdown level1 summary"><p>Returns the top docs that were collected by this collector. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">TopDocs GetTopDocs()</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><a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</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_ITopDocsCollector_GetTopDocs_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.ITopDocsCollector.GetTopDocs(System.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/TopDocsCollector.cs/#L271">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs_" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs*"></a> |
| <h4 id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs_System_Int32_" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs(System.Int32)">GetTopDocs(Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the documents in the rage [<code data-dev-comment-type="paramref" class="paramref">start</code> .. pq.Count) that were collected |
| by this collector. Note that if <code data-dev-comment-type="paramref" class="paramref">start</code> >= pq.Count, an empty <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a> is |
| returned. |
| <p> |
| This method is convenient to call if the application always asks for the |
| last results, starting from the last 'page'. |
| <p> |
| <strong>NOTE:</strong> you cannot call this method more than once for each search |
| execution. If you need to call it more than once, passing each time a |
| different <code data-dev-comment-type="paramref" class="paramref">start</code>, you should call <a class="xref" href="Lucene.Net.Search.ITopDocsCollector.html#Lucene_Net_Search_ITopDocsCollector_GetTopDocs">GetTopDocs()</a> and work |
| with the returned <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a> object, which will contain all the |
| results this search execution collected.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">TopDocs GetTopDocs(int start)</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">start</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><a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</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_ITopDocsCollector_GetTopDocs_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.ITopDocsCollector.GetTopDocs(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/TopDocsCollector.cs/#L289">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs_" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs*"></a> |
| <h4 id="Lucene_Net_Search_ITopDocsCollector_GetTopDocs_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.ITopDocsCollector.GetTopDocs(System.Int32,System.Int32)">GetTopDocs(Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the documents in the rage [<code data-dev-comment-type="paramref" class="paramref">start</code> .. <code data-dev-comment-type="paramref" class="paramref">start</code>+<code data-dev-comment-type="paramref" class="paramref">howMany</code>) that were |
| collected by this collector. Note that if <code data-dev-comment-type="paramref" class="paramref">start</code> >= pq.Count, an empty |
| <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a> is returned, and if pq.Count - <code data-dev-comment-type="paramref" class="paramref">start</code> < <code data-dev-comment-type="paramref" class="paramref">howMany</code>, then only the |
| available documents in [<code data-dev-comment-type="paramref" class="paramref">start</code> .. pq.Count) are returned. |
| <p> |
| This method is useful to call in case pagination of search results is |
| allowed by the search application, as well as it attempts to optimize the |
| memory used by allocating only as much as requested by <code data-dev-comment-type="paramref" class="paramref">howMany</code>. |
| <p> |
| <strong>NOTE:</strong> you cannot call this method more than once for each search |
| execution. If you need to call it more than once, passing each time a |
| different range, you should call <a class="xref" href="Lucene.Net.Search.ITopDocsCollector.html#Lucene_Net_Search_ITopDocsCollector_GetTopDocs">GetTopDocs()</a> and work with the |
| returned <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a> object, which will contain all the results this |
| search execution collected.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">TopDocs GetTopDocs(int start, int howMany)</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">start</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">howMany</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><a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </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_ITopDocsCollector.md&value=---%0Auid%3A%20Lucene.Net.Search.ITopDocsCollector%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/TopDocsCollector.cs/#L246" 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> |
