blob: eab00ebc6c2b66a925e11a4d2745b9016d7966a4 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class FunctionSecondPassGroupingCollector
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FunctionSecondPassGroupingCollector
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.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">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<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.Function.FunctionSecondPassGroupingCollector">
<h1 id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector" class="text-break">Class FunctionSecondPassGroupingCollector
</h1>
<div class="markdown level0 summary"><p>Concrete implementation of <a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html">AbstractSecondPassGroupingCollector&lt;TGroupValue&gt;</a> that groups based on
<span class="xref">Lucene.Net.Queries.Function.ValueSource</span> instances.</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.AbstractSecondPassGroupingCollector-1.html">AbstractSecondPassGroupingCollector</a>&lt;<span class="xref">Lucene.Net.Util.Mutable.MutableValue</span>&gt;</div>
<div class="level2"><span class="xref">FunctionSecondPassGroupingCollector</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractSecondPassGroupingCollector-1.html">IAbstractSecondPassGroupingCollector</a>&lt;<span class="xref">Lucene.Net.Util.Mutable.MutableValue</span>&gt;</div>
<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.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_m_groupMap">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.m_groupMap</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_m_groupDocs">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.m_groupDocs</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_SetScorer_Lucene_Net_Search_Scorer_">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.SetScorer(Scorer)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_Collect_System_Int32_">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.Collect(Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_AcceptsDocsOutOfOrder">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.AcceptsDocsOutOfOrder</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractSecondPassGroupingCollector_1_GetTopGroups_System_Int32_">AbstractSecondPassGroupingCollector&lt;MutableValue&gt;.GetTopGroups(Int32)</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.Function.html">Lucene.Net.Search.Grouping.Function</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Grouping.dll</h6>
<h5 id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FunctionSecondPassGroupingCollector : AbstractSecondPassGroupingCollector&lt;MutableValue&gt;, IAbstractSecondPassGroupingCollector&lt;MutableValue&gt;, ICollector</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector__ctor_System_Collections_Generic_IEnumerable_Lucene_Net_Search_Grouping_ISearchGroup_Lucene_Net_Util_Mutable_MutableValue___Lucene_Net_Search_Sort_Lucene_Net_Search_Sort_System_Int32_System_Boolean_System_Boolean_System_Boolean_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.%23ctor(System.Collections.Generic.IEnumerable%7BLucene.Net.Search.Grouping.ISearchGroup%7BLucene.Net.Util.Mutable.MutableValue%7D%7D%2CLucene.Net.Search.Sort%2CLucene.Net.Search.Sort%2CSystem.Int32%2CSystem.Boolean%2CSystem.Boolean%2CSystem.Boolean%2CLucene.Net.Queries.Function.ValueSource%2CSystem.Collections.IDictionary)%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/fix/apidocs-layout/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs/#L54">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector__ctor_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.#ctor*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector__ctor_System_Collections_Generic_IEnumerable_Lucene_Net_Search_Grouping_ISearchGroup_Lucene_Net_Util_Mutable_MutableValue___Lucene_Net_Search_Sort_Lucene_Net_Search_Sort_System_Int32_System_Boolean_System_Boolean_System_Boolean_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.#ctor(System.Collections.Generic.IEnumerable{Lucene.Net.Search.Grouping.ISearchGroup{Lucene.Net.Util.Mutable.MutableValue}},Lucene.Net.Search.Sort,Lucene.Net.Search.Sort,System.Int32,System.Boolean,System.Boolean,System.Boolean,Lucene.Net.Queries.Function.ValueSource,System.Collections.IDictionary)">FunctionSecondPassGroupingCollector(IEnumerable&lt;ISearchGroup&lt;MutableValue&gt;&gt;, Sort, Sort, Int32, Boolean, Boolean, Boolean, ValueSource, IDictionary)</h4>
<div class="markdown level1 summary"><p>Constructs a <a class="xref" href="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.html">FunctionSecondPassGroupingCollector</a> instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FunctionSecondPassGroupingCollector(IEnumerable&lt;ISearchGroup&lt;MutableValue&gt;&gt; searchGroups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, bool getScores, bool getMaxScores, bool fillSortFields, ValueSource groupByVS, IDictionary vsContext)</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.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Lucene.Net.Search.Grouping.ISearchGroup-1.html">ISearchGroup</a>&lt;<span class="xref">Lucene.Net.Util.Mutable.MutableValue</span>&gt;&gt;</td>
<td><span class="parametername">searchGroups</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Search.Grouping.SearchGroup-1.html">SearchGroup&lt;TGroupValue&gt;</a> instances collected during the first phase.</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.Sort</span></td>
<td><span class="parametername">groupSort</span></td>
<td><p>The group sort</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.Sort</span></td>
<td><span class="parametername">withinGroupSort</span></td>
<td><p>The sort inside a group</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">maxDocsPerGroup</span></td>
<td><p>The maximum number of documents to collect inside a group</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">getScores</span></td>
<td><p>Whether to include the scores</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">getMaxScores</span></td>
<td><p>Whether to include the maximum score</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">fillSortFields</span></td>
<td><p>Whether to fill the sort values in <a class="xref" href="Lucene.Net.Search.Grouping.TopGroups-1.html#Lucene_Net_Search_Grouping_TopGroups_1_WithinGroupSort">WithinGroupSort</a></p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Queries.Function.ValueSource</span></td>
<td><span class="parametername">groupByVS</span></td>
<td><p>The <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> to group by</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Collections.IDictionary</span></td>
<td><span class="parametername">vsContext</span></td>
<td><p>The value source context</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>When I/O related errors occur</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_RetrieveGroup_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.RetrieveGroup(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/fix/apidocs-layout/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs/#L63">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_RetrieveGroup_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.RetrieveGroup*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_RetrieveGroup_System_Int32_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.RetrieveGroup(System.Int32)">RetrieveGroup(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 override AbstractSecondPassGroupingCollector.SearchGroupDocs&lt;MutableValue&gt; RetrieveGroup(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="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.Grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs-1.html">AbstractSecondPassGroupingCollector.SearchGroupDocs</a>&lt;<span class="xref">Lucene.Net.Util.Mutable.MutableValue</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector&lt;Lucene.Net.Util.Mutable.MutableValue&gt;.RetrieveGroup(System.Int32)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.SetNextReader(Lucene.Net.Index.AtomicReaderContext)%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/fix/apidocs-layout/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs/#L70">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_SetNextReader_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.SetNextReader*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector.SetNextReader(Lucene.Net.Index.AtomicReaderContext)">SetNextReader(AtomicReaderContext)</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 SetNextReader(AtomicReaderContext context)</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">Lucene.Net.Index.AtomicReaderContext</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector&lt;Lucene.Net.Util.Mutable.MutableValue&gt;.SetNextReader(Lucene.Net.Index.AtomicReaderContext)</span></div>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.IAbstractSecondPassGroupingCollector-1.html">IAbstractSecondPassGroupingCollector&lt;TGroupValue&gt;</a>
</div>
<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionSecondPassGroupingCollector.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionSecondPassGroupingCollector%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/fix/apidocs-layout/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs/#L33" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</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>