blob: 9131fd509247a57b847786179ae26fe956cae774 [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 FunctionFirstPassGroupingCollector
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FunctionFirstPassGroupingCollector
| 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.Function.FunctionFirstPassGroupingCollector">
<h1 id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector" class="text-break">Class FunctionFirstPassGroupingCollector
</h1>
<div class="markdown level0 summary"><p>Concrete implementation of <a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html">AbstractFirstPassGroupingCollector&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.AbstractFirstPassGroupingCollector-1.html">AbstractFirstPassGroupingCollector</a>&lt;<span class="xref">Lucene.Net.Util.Mutable.MutableValue</span>&gt;</div>
<div class="level2"><span class="xref">FunctionFirstPassGroupingCollector</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractFirstPassGroupingCollector-1.html">IAbstractFirstPassGroupingCollector</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.AbstractFirstPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractFirstPassGroupingCollector_1_m_orderedGroups">AbstractFirstPassGroupingCollector&lt;MutableValue&gt;.m_orderedGroups</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractFirstPassGroupingCollector_1_GetTopGroups_System_Int32_System_Boolean_">AbstractFirstPassGroupingCollector&lt;MutableValue&gt;.GetTopGroups(Int32, Boolean)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractFirstPassGroupingCollector_1_SetScorer_Lucene_Net_Search_Scorer_">AbstractFirstPassGroupingCollector&lt;MutableValue&gt;.SetScorer(Scorer)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractFirstPassGroupingCollector_1_Collect_System_Int32_">AbstractFirstPassGroupingCollector&lt;MutableValue&gt;.Collect(Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html#Lucene_Net_Search_Grouping_AbstractFirstPassGroupingCollector_1_AcceptsDocsOutOfOrder">AbstractFirstPassGroupingCollector&lt;MutableValue&gt;.AcceptsDocsOutOfOrder</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_FunctionFirstPassGroupingCollector_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FunctionFirstPassGroupingCollector : AbstractFirstPassGroupingCollector&lt;MutableValue&gt;, IAbstractFirstPassGroupingCollector&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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector__ctor_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_Lucene_Net_Search_Sort_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.%23ctor(Lucene.Net.Queries.Function.ValueSource%2CSystem.Collections.IDictionary%2CLucene.Net.Search.Sort%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.Grouping/Function/FunctionFirstPassGroupingCollector.cs/#L55">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector__ctor_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.#ctor*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector__ctor_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_Lucene_Net_Search_Sort_System_Int32_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.#ctor(Lucene.Net.Queries.Function.ValueSource,System.Collections.IDictionary,Lucene.Net.Search.Sort,System.Int32)">FunctionFirstPassGroupingCollector(ValueSource, IDictionary, Sort, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a first pass collector.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FunctionFirstPassGroupingCollector(ValueSource groupByVS, IDictionary vsContext, Sort groupSort, int topNGroups)</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.Queries.Function.ValueSource</span></td>
<td><span class="parametername">groupByVS</span></td>
<td><p>The <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> instance 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 <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> context</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.Sort</span></td>
<td><span class="parametername">groupSort</span></td>
<td><p>The <span class="xref">Lucene.Net.Search.Sort</span> used to sort the
groups. The top sorted document within each group
according to groupSort, determines how that group
sorts against other groups. This must be non-null,
ie, if you want to groupSort by relevance use
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Sort.html#Lucene_Net_Search_Sort_RELEVANCE">RELEVANCE</a>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">topNGroups</span></td>
<td><p>How many top groups to keep.</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_CopyDocGroupValue_Lucene_Net_Util_Mutable_MutableValue_Lucene_Net_Util_Mutable_MutableValue_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.CopyDocGroupValue(Lucene.Net.Util.Mutable.MutableValue%2CLucene.Net.Util.Mutable.MutableValue)%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/Function/FunctionFirstPassGroupingCollector.cs/#L68">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_CopyDocGroupValue_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.CopyDocGroupValue*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_CopyDocGroupValue_Lucene_Net_Util_Mutable_MutableValue_Lucene_Net_Util_Mutable_MutableValue_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.CopyDocGroupValue(Lucene.Net.Util.Mutable.MutableValue,Lucene.Net.Util.Mutable.MutableValue)">CopyDocGroupValue(MutableValue, MutableValue)</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 MutableValue CopyDocGroupValue(MutableValue groupValue, MutableValue reuse)</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.Util.Mutable.MutableValue</span></td>
<td><span class="parametername">groupValue</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.Mutable.MutableValue</span></td>
<td><span class="parametername">reuse</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">Lucene.Net.Util.Mutable.MutableValue</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector&lt;Lucene.Net.Util.Mutable.MutableValue&gt;.CopyDocGroupValue(Lucene.Net.Util.Mutable.MutableValue, Lucene.Net.Util.Mutable.MutableValue)</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_Grouping_Function_FunctionFirstPassGroupingCollector_GetDocGroupValue_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.GetDocGroupValue(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/Function/FunctionFirstPassGroupingCollector.cs/#L62">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_GetDocGroupValue_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.GetDocGroupValue*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_GetDocGroupValue_System_Int32_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.GetDocGroupValue(System.Int32)">GetDocGroupValue(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 MutableValue GetDocGroupValue(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><span class="xref">Lucene.Net.Util.Mutable.MutableValue</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector&lt;Lucene.Net.Util.Mutable.MutableValue&gt;.GetDocGroupValue(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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs/#L78">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_SetNextReader_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.SetNextReader*"></a>
<h4 id="Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector.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.AbstractFirstPassGroupingCollector&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.IAbstractFirstPassGroupingCollector-1.html">IAbstractFirstPassGroupingCollector&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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Function_FunctionFirstPassGroupingCollector.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Function.FunctionFirstPassGroupingCollector%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/Function/FunctionFirstPassGroupingCollector.cs/#L32" 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>