| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class GroupingSearch |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class GroupingSearch |
| | 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.GroupingSearch"> |
| |
| |
| <h1 id="Lucene_Net_Search_Grouping_GroupingSearch" data-uid="Lucene.Net.Search.Grouping.GroupingSearch" class="text-break">Class GroupingSearch |
| </h1> |
| <div class="markdown level0 summary"><p>Convenience class to perform grouping in a non distributed environment.</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"><span class="xref">GroupingSearch</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <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_GroupingSearch_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class GroupingSearch</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_GroupingSearch__ctor_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.%23ctor(Lucene.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Grouping/GroupingSearch.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_Lucene_Net_Queries_Function_ValueSource_System_Collections_IDictionary_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor(Lucene.Net.Queries.Function.ValueSource,System.Collections.IDictionary)">GroupingSearch(ValueSource, IDictionary)</h4> |
| <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a> instance that groups documents by function using a <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> |
| instance.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public GroupingSearch(ValueSource groupFunction, IDictionary valueSourceContext)</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">groupFunction</span></td> |
| <td><p>The function to group by specified as <span class="xref">Lucene.Net.Queries.Function.ValueSource</span></p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.IDictionary</span></td> |
| <td><span class="parametername">valueSourceContext</span></td> |
| <td><p>The context of the specified groupFunction</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_GroupingSearch__ctor_Lucene_Net_Search_Filter_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.%23ctor(Lucene.Net.Search.Filter)%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/GroupingSearch.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_Lucene_Net_Search_Filter_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor(Lucene.Net.Search.Filter)">GroupingSearch(Filter)</h4> |
| <div class="markdown level1 summary"><p>Constructor for grouping documents by doc block. |
| This constructor can only be used when documents belonging in a group are indexed in one block.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public GroupingSearch(Filter groupEndDocs)</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.Search.Filter</span></td> |
| <td><span class="parametername">groupEndDocs</span></td> |
| <td><p>The filter that marks the last document in all doc blocks</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_GroupingSearch__ctor_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.%23ctor(System.String)%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/GroupingSearch.cs/#L85">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch__ctor_System_String_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.#ctor(System.String)">GroupingSearch(String)</h4> |
| <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a> instance that groups documents by index terms using the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FieldCache.html">FieldCache</a>. |
| The group field can only have one token per document. This means that the field must not be analysed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public GroupingSearch(string groupField)</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.String</span></td> |
| <td><span class="parametername">groupField</span></td> |
| <td><p>The name of the field to group by.</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_GroupingSearch_DisableCaching.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.DisableCaching%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/GroupingSearch.cs/#L395">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_DisableCaching_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.DisableCaching*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_DisableCaching" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.DisableCaching">DisableCaching()</h4> |
| <div class="markdown level1 summary"><p>Disables any enabled cache.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch DisableCaching()</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.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_GetAllGroupHeads.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.GetAllGroupHeads%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/GroupingSearch.cs/#L542">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllGroupHeads_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllGroupHeads*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllGroupHeads" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllGroupHeads">GetAllGroupHeads()</h4> |
| <div class="markdown level1 summary"><p>Returns the matching group heads if <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroupHeads_System_Boolean_">SetAllGroupHeads(Boolean)</a> was set to true or an empty bit set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IBits GetAllGroupHeads()</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">Lucene.Net.Util.IBits</span></td> |
| <td><p>The matching group heads if <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroupHeads_System_Boolean_">SetAllGroupHeads(Boolean)</a> was set to true or an empty bit set</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_GroupingSearch_GetAllMatchingGroups.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups%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/GroupingSearch.cs/#L519">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups">GetAllMatchingGroups()</h4> |
| <div class="markdown level1 summary"><p>If <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroups_System_Boolean_">SetAllGroups(Boolean)</a> was set to <code>true</code> then all matching groups are returned, otherwise |
| an empty collection is returned.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ICollection GetAllMatchingGroups()</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.Collections.ICollection</span></td> |
| <td><p>all matching groups are returned, or an empty collection</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific used to get the groups if the type is unknown or if the code expects |
| any type, since <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups__1">GetAllMatchingGroups<T>()</a> |
| will throw an exception if the return type is incorrect.</p> |
| </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_GroupingSearch_GetAllMatchingGroups__1.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups%60%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">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/GroupingSearch.cs/#L504">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_GetAllMatchingGroups__1" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GetAllMatchingGroups``1">GetAllMatchingGroups<T>()</h4> |
| <div class="markdown level1 summary"><p>If <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroups_System_Boolean_">SetAllGroups(Boolean)</a> was set to <code>true</code> then all matching groups are returned, otherwise |
| an empty collection is returned.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ICollection<T> GetAllMatchingGroups<T>()</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.Collections.Generic.ICollection</span><T></td> |
| <td><p>all matching groups are returned, or an empty collection</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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">T</span></td> |
| <td><p>The group value type. This can be a <span class="xref">Lucene.Net.Util.BytesRef</span> or a <span class="xref">Lucene.Net.Util.Mutable.MutableValue</span> instance. |
| If grouping by doc block this the group value is always <code>null</code>.</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_GroupingSearch_GroupByDocBlock__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.GroupByDocBlock%60%601(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Filter%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L350">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_GroupByDocBlock_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GroupByDocBlock*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_GroupByDocBlock__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GroupByDocBlock``1(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Filter,Lucene.Net.Search.Query,System.Int32,System.Int32)">GroupByDocBlock<TGroupValue>(IndexSearcher, Filter, Query, Int32, 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 virtual ITopGroups<TGroupValue> GroupByDocBlock<TGroupValue>(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Filter</span></td> |
| <td><span class="parametername">filter</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</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.ITopGroups-1.html">ITopGroups</a><TGroupValue></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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">TGroupValue</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_GroupingSearch_GroupByFieldOrFunction__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.GroupByFieldOrFunction%60%601(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Filter%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L207">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_GroupByFieldOrFunction_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GroupByFieldOrFunction*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_GroupByFieldOrFunction__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.GroupByFieldOrFunction``1(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Filter,Lucene.Net.Search.Query,System.Int32,System.Int32)">GroupByFieldOrFunction<TGroupValue>(IndexSearcher, Filter, Query, Int32, 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 virtual ITopGroups<TGroupValue> GroupByFieldOrFunction<TGroupValue>(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Filter</span></td> |
| <td><span class="parametername">filter</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</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.ITopGroups-1.html">ITopGroups</a><TGroupValue></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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">TGroupValue</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_GroupingSearch_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.Search(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Filter%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L160">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_Search_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Filter,Lucene.Net.Search.Query,System.Int32,System.Int32)">Search(IndexSearcher, Filter, Query, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Executes a grouped search. Both the first pass and second pass are executed on the specified searcher.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ITopGroups<object> Search(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Search.IndexSearcher</span> instance to execute the grouped search on.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Filter</span></td> |
| <td><span class="parametername">filter</span></td> |
| <td><p>The filter to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td><p>The group offset</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</span></td> |
| <td><p>The number of groups to return from the specified group offset</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><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups</a><<span class="xref">System.Object</span>></td> |
| <td><p>the grouped result as a <a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></a> instance</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>If any 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_GroupingSearch_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.Search(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L129">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_Search_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Query,System.Int32,System.Int32)">Search(IndexSearcher, Query, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Executes a grouped search. Both the first pass and second pass are executed on the specified searcher.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ITopGroups<object> Search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Search.IndexSearcher</span> instance to execute the grouped search on.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td><p>The group offset</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</span></td> |
| <td><p>The number of groups to return from the specified group offset</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><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups</a><<span class="xref">System.Object</span>></td> |
| <td><p>the grouped result as a <a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></a> instance</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>If any 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_GroupingSearch_Search__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.Search%60%601(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Filter%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L191">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_Search_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_Search__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Filter_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search``1(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Filter,Lucene.Net.Search.Query,System.Int32,System.Int32)">Search<TGroupValue>(IndexSearcher, Filter, Query, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Executes a grouped search. Both the first pass and second pass are executed on the specified searcher.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ITopGroups<TGroupValue> Search<TGroupValue>(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Search.IndexSearcher</span> instance to execute the grouped search on.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Filter</span></td> |
| <td><span class="parametername">filter</span></td> |
| <td><p>The filter to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td><p>The group offset</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</span></td> |
| <td><p>The number of groups to return from the specified group offset</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><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups</a><TGroupValue></td> |
| <td><p>the grouped result as a <a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></a> instance</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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">TGroupValue</span></td> |
| <td><p>The expected return type of the search.</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>If any 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_GroupingSearch_Search__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.Search%60%601(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Search.Query%2CSystem.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.Grouping/GroupingSearch.cs/#L145">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_Search_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_Search__1_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.Search``1(Lucene.Net.Search.IndexSearcher,Lucene.Net.Search.Query,System.Int32,System.Int32)">Search<TGroupValue>(IndexSearcher, Query, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Executes a grouped search. Both the first pass and second pass are executed on the specified searcher.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ITopGroups<TGroupValue> Search<TGroupValue>(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Search.IndexSearcher</span> instance to execute the grouped search on.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to execute with the grouping</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupOffset</span></td> |
| <td><p>The group offset</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">groupLimit</span></td> |
| <td><p>The number of groups to return from the specified group offset</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><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups</a><TGroupValue></td> |
| <td><p>the grouped result as a <a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></a> instance</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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">TGroupValue</span></td> |
| <td><p>The expected return type of the search.</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>If any 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_GroupingSearch_SetAllGroupHeads_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroupHeads(System.Boolean)%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/GroupingSearch.cs/#L532">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroupHeads_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroupHeads*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroupHeads_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroupHeads(System.Boolean)">SetAllGroupHeads(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Whether to compute all group heads (most relevant document per group) matching the query. |
| <p> |
| This feature isn't enabled when grouping by doc block. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetAllGroupHeads(bool allGroupHeads)</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.Boolean</span></td> |
| <td><span class="parametername">allGroupHeads</span></td> |
| <td><p>Whether to compute all group heads (most relevant document per group) matching the query</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetAllGroups_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroups(System.Boolean)%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/GroupingSearch.cs/#L491">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroups_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroups*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroups_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetAllGroups(System.Boolean)">SetAllGroups(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Whether to also compute all groups matching the query. |
| This can be used to determine the number of groups, which can be used for accurate pagination. |
| <p> |
| When grouping by doc block the number of groups are automatically included in the <a class="xref" href="Lucene.Net.Search.Grouping.TopGroups.html">TopGroups</a> and this |
| option doesn't have any influence. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetAllGroups(bool allGroups)</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.Boolean</span></td> |
| <td><span class="parametername">allGroups</span></td> |
| <td><p>to also compute all groups matching the query</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetCaching_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetCaching(System.Int32%2CSystem.Boolean)%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/GroupingSearch.cs/#L383">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetCaching_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetCaching*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetCaching_System_Int32_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetCaching(System.Int32,System.Boolean)">SetCaching(Int32, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Enables caching for the second pass search. The cache will not contain more than the maximum specified documents. |
| The cache is filled during the first pass searched and then replayed during the second pass searched. |
| If the cache grows beyond the specified limit, then the cache is purged and not used in the second pass search.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetCaching(int maxDocsToCache, bool cacheScores)</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">maxDocsToCache</span></td> |
| <td><p>The maximum number of documents the cache is allowed to hold</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">cacheScores</span></td> |
| <td><p>Whether to cache the scores</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetCachingInMB_System_Double_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetCachingInMB(System.Double%2CSystem.Boolean)%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/GroupingSearch.cs/#L367">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetCachingInMB_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetCachingInMB*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetCachingInMB_System_Double_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetCachingInMB(System.Double,System.Boolean)">SetCachingInMB(Double, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Enables caching for the second pass search. The cache will not grow over a specified limit in MB. |
| The cache is filled during the first pass searched and then replayed during the second pass searched. |
| If the cache grows beyond the specified limit, then the cache is purged and not used in the second pass search.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetCachingInMB(double maxCacheRAMMB, bool cacheScores)</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.Double</span></td> |
| <td><span class="parametername">maxCacheRAMMB</span></td> |
| <td><p>The maximum amount in MB the cache is allowed to hold</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">cacheScores</span></td> |
| <td><p>Whether to cache the scores</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetFillSortFields_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetFillSortFields(System.Boolean)%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/GroupingSearch.cs/#L453">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetFillSortFields_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetFillSortFields*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetFillSortFields_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetFillSortFields(System.Boolean)">SetFillSortFields(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Whether to also fill the sort fields per returned group and groups docs.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetFillSortFields(bool fillSortFields)</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.Boolean</span></td> |
| <td><span class="parametername">fillSortFields</span></td> |
| <td><p>Whether to also fill the sort fields per returned group and groups docs</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetGroupDocsLimit_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsLimit(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/GroupingSearch.cs/#L442">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupDocsLimit_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsLimit*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupDocsLimit_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsLimit(System.Int32)">SetGroupDocsLimit(Int32)</h4> |
| <div class="markdown level1 summary"><p>Specifies the number of documents to return inside a group from the specified groupDocsOffset.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetGroupDocsLimit(int groupDocsLimit)</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">groupDocsLimit</span></td> |
| <td><p>The number of documents to return inside a group</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetGroupDocsOffset_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsOffset(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/GroupingSearch.cs/#L431">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupDocsOffset_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsOffset*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupDocsOffset_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupDocsOffset(System.Int32)">SetGroupDocsOffset(Int32)</h4> |
| <div class="markdown level1 summary"><p>Specifies the offset for documents inside a group.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetGroupDocsOffset(int groupDocsOffset)</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">groupDocsOffset</span></td> |
| <td><p>The offset for documents inside 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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetGroupSort_Lucene_Net_Search_Sort_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetGroupSort(Lucene.Net.Search.Sort)%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/GroupingSearch.cs/#L408">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupSort_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupSort*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetGroupSort_Lucene_Net_Search_Sort_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetGroupSort(Lucene.Net.Search.Sort)">SetGroupSort(Sort)</h4> |
| <div class="markdown level1 summary"><p>Specifies how groups are sorted. |
| Defaults to <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Sort.html#Lucene_Net_Search_Sort_RELEVANCE">RELEVANCE</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetGroupSort(Sort groupSort)</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.Search.Sort</span></td> |
| <td><span class="parametername">groupSort</span></td> |
| <td><p>The sort for the groups.</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetIncludeMaxScore_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeMaxScore(System.Boolean)%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/GroupingSearch.cs/#L475">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetIncludeMaxScore_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeMaxScore*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetIncludeMaxScore_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeMaxScore(System.Boolean)">SetIncludeMaxScore(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Whether to include the score of the most relevant document per group.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetIncludeMaxScore(bool includeMaxScore)</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.Boolean</span></td> |
| <td><span class="parametername">includeMaxScore</span></td> |
| <td><p>Whether to include the score of the most relevant document per group</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetIncludeScores_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeScores(System.Boolean)%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/GroupingSearch.cs/#L464">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetIncludeScores_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeScores*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetIncludeScores_System_Boolean_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetIncludeScores(System.Boolean)">SetIncludeScores(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Whether to include the scores per doc inside a group.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetIncludeScores(bool includeScores)</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.Boolean</span></td> |
| <td><span class="parametername">includeScores</span></td> |
| <td><p>Whether to include the scores per doc inside a group</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetInitialSize_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetInitialSize(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/GroupingSearch.cs/#L558">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetInitialSize_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetInitialSize*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetInitialSize_System_Int32_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetInitialSize(System.Int32)">SetInitialSize(Int32)</h4> |
| <div class="markdown level1 summary"><p>Sets the initial size of some internal used data structures. |
| This prevents growing data structures many times. This can improve the performance of the grouping at the cost of |
| more initial RAM. |
| <p> |
| The <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroups_System_Boolean_">SetAllGroups(Boolean)</a> and <a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html#Lucene_Net_Search_Grouping_GroupingSearch_SetAllGroupHeads_System_Boolean_">SetAllGroupHeads(Boolean)</a> features use this option. |
| Defaults to 128. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetInitialSize(int initialSize)</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">initialSize</span></td> |
| <td><p>The initial size of some internal used data structures</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></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_GroupingSearch_SetSortWithinGroup_Lucene_Net_Search_Sort_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch.SetSortWithinGroup(Lucene.Net.Search.Sort)%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/GroupingSearch.cs/#L420">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_GroupingSearch_SetSortWithinGroup_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetSortWithinGroup*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_GroupingSearch_SetSortWithinGroup_Lucene_Net_Search_Sort_" data-uid="Lucene.Net.Search.Grouping.GroupingSearch.SetSortWithinGroup(Lucene.Net.Search.Sort)">SetSortWithinGroup(Sort)</h4> |
| <div class="markdown level1 summary"><p>Specified how documents inside a group are sorted. |
| Defaults to <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Sort.html#Lucene_Net_Search_Sort_RELEVANCE">RELEVANCE</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual GroupingSearch SetSortWithinGroup(Sort sortWithinGroup)</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.Search.Sort</span></td> |
| <td><span class="parametername">sortWithinGroup</span></td> |
| <td><p>The sort for documents inside a group</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><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></td> |
| <td><p><code>this</code></p> |
| </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_Grouping_GroupingSearch.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.GroupingSearch%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/GroupingSearch.cs/#L35" 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> |
