| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class AbstractAllGroupHeadsCollector<GH> |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class AbstractAllGroupHeadsCollector<GH> |
| | 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="grouping/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.Grouping.AbstractAllGroupHeadsCollector`1"> |
| |
| |
| <h1 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1" class="text-break">Class AbstractAllGroupHeadsCollector<GH> |
| </h1> |
| <div class="markdown level0 summary"><p>This collector specializes in collecting the most relevant document (group head) for each group that match the query.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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"><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html">AbstractAllGroupHeadsCollector</a></div> |
| <div class="level2"><span class="xref">AbstractAllGroupHeadsCollector<GH></span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Search.Grouping.Function.FunctionAllGroupHeadsCollector.html">FunctionAllGroupHeadsCollector</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Search.Grouping.Terms.TermAllGroupHeadsCollector-1.html">TermAllGroupHeadsCollector<GH></a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">Lucene.Net.Search.ICollector</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_SetScorer_Lucene_Net_Search_Scorer_">AbstractAllGroupHeadsCollector.SetScorer(Scorer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_">AbstractAllGroupHeadsCollector.SetNextReader(AtomicReaderContext)</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</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> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Grouping.html">Lucene.Net.Search.Grouping</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Grouping.dll</h6> |
| <h5 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class AbstractAllGroupHeadsCollector<GH> : AbstractAllGroupHeadsCollector, ICollector where GH : AbstractAllGroupHeadsCollector_GroupHead</code></pre> |
| </div> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">GH</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Grouping_AbstractAllGroupHeadsCollector_1__ctor_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.%23ctor(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.Grouping/AbstractAllGroupHeadsCollector.cs/#L38">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1__ctor_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1__ctor_System_Int32_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.#ctor(System.Int32)">AbstractAllGroupHeadsCollector(Int32)</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 AbstractAllGroupHeadsCollector(int numberOfSorts)</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">numberOfSorts</span></td> |
| <td></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_Grouping_AbstractAllGroupHeadsCollector_1_m_compIDXEnd.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.m_compIDXEnd%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L35">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_m_compIDXEnd" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.m_compIDXEnd">m_compIDXEnd</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 readonly int m_compIDXEnd</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.Int32</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_Grouping_AbstractAllGroupHeadsCollector_1_m_reversed.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.m_reversed%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L34">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_m_reversed" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.m_reversed">m_reversed</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 readonly int[] m_reversed</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.Int32</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_Grouping_AbstractAllGroupHeadsCollector_1_m_temporalResult.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.m_temporalResult%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L36">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_m_temporalResult" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.m_temporalResult">m_temporalResult</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 readonly AbstractAllGroupHeadsCollector<GH>.TemporalResult m_temporalResult</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.Grouping.AbstractAllGroupHeadsCollector-1.TemporalResult.html">AbstractAllGroupHeadsCollector.TemporalResult</a><></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_Grouping_AbstractAllGroupHeadsCollector_1_AcceptsDocsOutOfOrder.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.AcceptsDocsOutOfOrder%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L141">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_AcceptsDocsOutOfOrder_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.AcceptsDocsOutOfOrder*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_AcceptsDocsOutOfOrder" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.AcceptsDocsOutOfOrder">AcceptsDocsOutOfOrder</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 bool AcceptsDocsOutOfOrder { 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_AcceptsDocsOutOfOrder">AbstractAllGroupHeadsCollector.AcceptsDocsOutOfOrder</a></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_Grouping_AbstractAllGroupHeadsCollector_1_CollectedGroupHeads.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.CollectedGroupHeads%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_CollectedGroupHeads_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.CollectedGroupHeads*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_CollectedGroupHeads" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.CollectedGroupHeads">CollectedGroupHeads</h4> |
| <div class="markdown level1 summary"><p>Returns the collected group heads. |
| Subsequent calls should return the same group heads.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected abstract ICollection<GH> CollectedGroupHeads { 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.Collections.Generic.ICollection</span><GH></td> |
| <td><p>the collected group heads</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_Grouping_AbstractAllGroupHeadsCollector_1_GroupHeadsCount.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.GroupHeadsCount%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L86">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_GroupHeadsCount_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.GroupHeadsCount*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_GroupHeadsCount" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.GroupHeadsCount">GroupHeadsCount</h4> |
| <div class="markdown level1 summary"><p>The number of group heads found for a query. |
| LUCENENET NOTE: This was groupHeadsSize() in Lucene</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 GroupHeadsCount { 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><p>the number of group heads found for a query.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_GroupHeadsCount">AbstractAllGroupHeadsCollector.GroupHeadsCount</a></div> |
| <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_Grouping_AbstractAllGroupHeadsCollector_1_Collect_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.Collect(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.Grouping/AbstractAllGroupHeadsCollector.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_Collect_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.Collect*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_Collect_System_Int32_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.Collect(System.Int32)">Collect(Int32)</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 void Collect(int doc)</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">doc</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_Collect_System_Int32_">AbstractAllGroupHeadsCollector.Collect(Int32)</a></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_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeadAndAddIfNotExist_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.RetrieveGroupHeadAndAddIfNotExist(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.Grouping/AbstractAllGroupHeadsCollector.cs/#L98">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeadAndAddIfNotExist_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeadAndAddIfNotExist*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeadAndAddIfNotExist_System_Int32_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeadAndAddIfNotExist(System.Int32)">RetrieveGroupHeadAndAddIfNotExist(Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the group head and puts it into <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.TemporalResult.html">AbstractAllGroupHeadsCollector<GH>.TemporalResult</a>. |
| If the group head wasn't encountered before then it will be added to the collected group heads. |
| <p> |
| The <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.TemporalResult.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_TemporalResult_Stop">Stop</a> property will be <code>true</code> if the group head wasn't encountered before |
| otherwise <code>false</code>. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected abstract override void RetrieveGroupHeadAndAddIfNotExist(int doc)</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">doc</span></td> |
| <td><p>The document to retrieve the group head for.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_RetrieveGroupHeadAndAddIfNotExist_System_Int32_">AbstractAllGroupHeadsCollector.RetrieveGroupHeadAndAddIfNotExist(Int32)</a></div> |
| <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>If I/O related errors occur</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_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.RetrieveGroupHeads%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeads*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeads">RetrieveGroupHeads()</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 int[] RetrieveGroupHeads()</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><p>an int array containing all group heads. The size of the array is equal to number of collected unique groups.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_RetrieveGroupHeads">AbstractAllGroupHeadsCollector.RetrieveGroupHeads()</a></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_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601.RetrieveGroupHeads(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.Grouping/AbstractAllGroupHeadsCollector.cs/#L50">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeads*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_1_RetrieveGroupHeads_System_Int32_" data-uid="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector`1.RetrieveGroupHeads(System.Int32)">RetrieveGroupHeads(Int32)</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 FixedBitSet RetrieveGroupHeads(int maxDoc)</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">maxDoc</span></td> |
| <td><p>The maxDoc of the top level <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Index.IndexReader.html">IndexReader</a></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><span class="xref">Lucene.Net.Util.FixedBitSet</span></td> |
| <td><p>a <span class="xref">Lucene.Net.Util.FixedBitSet</span> containing all group heads.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html#Lucene_Net_Search_Grouping_AbstractAllGroupHeadsCollector_RetrieveGroupHeads_System_Int32_">AbstractAllGroupHeadsCollector.RetrieveGroupHeads(Int32)</a></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">Lucene.Net.Search.ICollector</span> |
| </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_Grouping_AbstractAllGroupHeadsCollector_1.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector%601%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.Grouping/AbstractAllGroupHeadsCollector.cs/#L31" 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> |
