| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Namespace Lucene.Net.Search.Grouping |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Namespace Lucene.Net.Search.Grouping |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation "> |
| <meta name="generator" content="docfx 2.50.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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"> |
| |
| <h1 id="Lucene_Net_Search_Grouping" data-uid="Lucene.Net.Search.Grouping" class="text-break">Namespace Lucene.Net.Search.Grouping |
| </h1> |
| <div class="markdown level0 summary"></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="markdown level0 remarks"></div> |
| <h3 id="classes">Classes |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector.html">AbstractAllGroupHeadsCollector</a></h4> |
| <section><p>LUCENENET specific class used to reference an |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.html">AbstractAllGroupHeadsCollector<GH></a> subclass |
| without refering to its generic closing type.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector_GroupHead.html">AbstractAllGroupHeadsCollector_GroupHead</a></h4> |
| <section><p>Represents a group head. A group head is the most relevant document for a particular group. |
| The relevancy is based is usually based on the sort. |
| <p> |
| The group head contains a group value with its associated most relevant document id. |
| </p></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.html">AbstractAllGroupHeadsCollector<GH></a></h4> |
| <section><p>This collector specializes in collecting the most relevant document (group head) for each group that match the query.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.TemporalResult.html">AbstractAllGroupHeadsCollector<GH>.TemporalResult</a></h4> |
| <section><p>Contains the result of group head retrieval. |
| To prevent new object creations of this class for every collect.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupsCollector-1.html">AbstractAllGroupsCollector<TGroupValue></a></h4> |
| <section><p>A collector that collects all groups that match the |
| query. Only the group value is collected, and the order |
| is undefined. This collector does not determine |
| the most relevant document of a group.</p> |
| <p><p> |
| This is an abstract version. Concrete implementations define |
| what a group actually is and how it is internally collected. |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector.html">AbstractDistinctValuesCollector</a></h4> |
| <section><p>LUCENENET specific class used to nest the <a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector.GroupCount-1.html">AbstractDistinctValuesCollector.GroupCount<TGroupValue></a> |
| class so it has similar syntax to that in Java Lucene |
| (AbstractDistinctValuesCollector.GroupCount{TGroupValue} rather than |
| AbstractDistinctValuesCollector{GC}.GroupCount{TGroupValue}).</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector.GroupCount-1.html">AbstractDistinctValuesCollector.GroupCount<TGroupValue></a></h4> |
| <section><p>Returned by <a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector-1.html#Lucene_Net_Search_Grouping_AbstractDistinctValuesCollector_1_Groups">Groups</a>, |
| representing the value and set of distinct values for the group.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector-1.html">AbstractDistinctValuesCollector<GC></a></h4> |
| <section><p>A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html">AbstractFirstPassGroupingCollector<TGroupValue></a></h4> |
| <section><p>FirstPassGroupingCollector is the first of two passes necessary |
| to collect grouped hits. This pass gathers the top N sorted |
| groups. Concrete subclasses define what a group is and how it |
| is internally collected.</p> |
| <p><p> |
| See <a href="https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/grouping/src/java/org/apache/lucene/search/grouping/package.html">org.apache.lucene.search.grouping</a> for more |
| details including a full code example. |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html">AbstractGroupFacetCollector</a></h4> |
| <section><p>Base class for computing grouped facets.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.AbstractSegmentResult.html">AbstractGroupFacetCollector.AbstractSegmentResult</a></h4> |
| <section><p>Contains the local grouped segment counts for a particular segment. |
| Each <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.AbstractSegmentResult.html">AbstractGroupFacetCollector.AbstractSegmentResult</a> must be added together.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.FacetEntry.html">AbstractGroupFacetCollector.FacetEntry</a></h4> |
| <section><p>Represents a facet entry with a value and a count.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.GroupedFacetResult.html">AbstractGroupFacetCollector.GroupedFacetResult</a></h4> |
| <section><p>The grouped facet result. Containing grouped facet entries, total count and total missing count.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector.html">AbstractSecondPassGroupingCollector</a></h4> |
| <section><p>LUCENENET specific class used to simulate the syntax used |
| to access nested classes of <a class="xref" href="Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector-1.html">AbstractAllGroupHeadsCollector<GH></a> |
| without referencing the generic closing type.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs-1.html">AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue></a></h4> |
| <section></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector-1.html">AbstractSecondPassGroupingCollector<TGroupValue></a></h4> |
| <section><p>SecondPassGroupingCollector is the second of two passes |
| necessary to collect grouped docs. This pass gathers the |
| top N documents per top group computed from the |
| first pass. Concrete subclasses define what a group is and how it |
| is internally collected. |
| <p> |
| See <a href="https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/grouping/src/java/org/apache/lucene/search/grouping/package.html">org.apache.lucene.search.grouping</a> for more |
| details including a full code example. |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.BlockGroupingCollector.html">BlockGroupingCollector</a></h4> |
| <section><p>BlockGroupingCollector performs grouping with a |
| single pass collector, as long as you are grouping by a |
| doc block field, ie all documents sharing a given group |
| value were indexed as a doc block using the atomic |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_AddDocuments_System_Collections_Generic_IEnumerable_System_Collections_Generic_IEnumerable_Lucene_Net_Index_IIndexableField___Lucene_Net_Analysis_Analyzer_">AddDocuments(IEnumerable<IEnumerable<IIndexableField>>, Analyzer)</a> or |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_UpdateDocuments_Lucene_Net_Index_Term_System_Collections_Generic_IEnumerable_System_Collections_Generic_IEnumerable_Lucene_Net_Index_IIndexableField___Lucene_Net_Analysis_Analyzer_">UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>, Analyzer)</a> |
| API.</p> |
| <p><p> |
| This results in faster performance (~25% faster QPS) |
| than the two-pass grouping collectors, with the tradeoff |
| being that the documents in each group must always be |
| indexed as a block. This collector also fills in |
| TopGroups.totalGroupCount without requiring the separate |
| <a class="xref" href="Lucene.Net.Search.Grouping.Terms.TermAllGroupsCollector.html">TermAllGroupsCollector</a>. However, this collector does |
| not fill in the groupValue of each group; this field |
| will always be null. |
| </p> |
| <p> |
| <code>NOTE</code>: this collector makes no effort to verify |
| the docs were in fact indexed as a block, so it's up to |
| you to ensure this was the case. |
| </p> |
| <p> |
| See <a href="https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/grouping/src/java/org/apache/lucene/search/grouping/package.html">org.apache.lucene.search.grouping</a> for more |
| details including a full code example. |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.CollectedSearchGroup-1.html">CollectedSearchGroup<TGroupValue></a></h4> |
| <section><p>Expert: representation of a group in <a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html">AbstractFirstPassGroupingCollector<TGroupValue></a>, |
| tracking the top doc and <a class="xref" href="../Lucene.Net/Lucene.Net.Search.FieldComparer.html">FieldComparer</a> slot.</p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.GroupDocs-1.html">GroupDocs<TGroupValue></a></h4> |
| <section><p>Represents one group in the results.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.GroupingSearch.html">GroupingSearch</a></h4> |
| <section><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></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.SearchGroup.html">SearchGroup</a></h4> |
| <section><p>LUCENENET specific class used to nest types to mimic the syntax used |
| by Lucene (that is, without specifying the generic closing type of <a class="xref" href="Lucene.Net.Search.Grouping.SearchGroup-1.html">SearchGroup<TGroupValue></a>)</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.SearchGroup-1.html">SearchGroup<TGroupValue></a></h4> |
| <section><p>Represents a group that is found during the first pass search.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.TopGroups.html">TopGroups</a></h4> |
| <section><p>LUCENENET specific class used to nest types to mimic the syntax used |
| by Lucene (that is, without specifying the generic closing type of <a class="xref" href="Lucene.Net.Search.Grouping.TopGroups-1.html">TopGroups<TGroupValue></a>)</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.TopGroups-1.html">TopGroups<TGroupValue></a></h4> |
| <section><p>Represents result returned by a grouping search.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p> |
| </section> |
| <h3 id="interfaces">Interfaces |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.AbstractDistinctValuesCollector.IGroupCount-1.html">AbstractDistinctValuesCollector.IGroupCount<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to TGroupValue</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractAllGroupsCollector-1.html">IAbstractAllGroupsCollector<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to TGroupValue</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractDistinctValuesCollector-1.html">IAbstractDistinctValuesCollector<GC></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to GC</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractFirstPassGroupingCollector-1.html">IAbstractFirstPassGroupingCollector<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to TGroupValue |
| to simulate Java's wildcard generics.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.IAbstractSecondPassGroupingCollector-1.html">IAbstractSecondPassGroupingCollector<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to TGroupValue |
| to simulate Java's wildcard generics.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.ICollectedSearchGroup.html">ICollectedSearchGroup</a></h4> |
| <section><p>LUCENENET specific interface for passing/comparing the CollectedSearchGroup |
| without referencing its generic closing type</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.IGroupDocs-1.html">IGroupDocs<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to apply covariance to TGroupValue |
| to simulate Java's wildcard generics.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.ISearchGroup-1.html">ISearchGroup<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to provide covariance |
| with the TGroupValue type to simulate Java's wildcard generics.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></a></h4> |
| <section><p>LUCENENET specific interface used to provide covariance |
| with the TGroupValue type to simulate Java's wildcard generics.</p> |
| </section> |
| <h3 id="enums">Enums |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.Search.Grouping.TopGroups.ScoreMergeMode.html">TopGroups.ScoreMergeMode</a></h4> |
| <section><p>How the GroupDocs score (if any) should be merged. </p> |
| </section> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| </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="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |
