| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class TermGroupFacetCollector |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class TermGroupFacetCollector |
| | 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.Terms.TermGroupFacetCollector"> |
| |
| |
| <h1 id="Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector" data-uid="Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector" class="text-break">Class TermGroupFacetCollector |
| </h1> |
| <div class="markdown level0 summary"><p>An implementation of <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html">AbstractGroupFacetCollector</a> that computes grouped facets based on the indexed terms |
| from the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FieldCache.html">FieldCache</a>.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html">AbstractGroupFacetCollector</a></div> |
| <div class="level2"><span class="xref">TermGroupFacetCollector</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">Lucene.Net.Search.ICollector</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_groupField">AbstractGroupFacetCollector.m_groupField</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_facetField">AbstractGroupFacetCollector.m_facetField</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_facetPrefix">AbstractGroupFacetCollector.m_facetPrefix</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_segmentResults">AbstractGroupFacetCollector.m_segmentResults</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_segmentFacetCounts">AbstractGroupFacetCollector.m_segmentFacetCounts</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_segmentTotalCount">AbstractGroupFacetCollector.m_segmentTotalCount</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_startFacetOrd">AbstractGroupFacetCollector.m_startFacetOrd</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_m_endFacetOrd">AbstractGroupFacetCollector.m_endFacetOrd</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_MergeSegmentResults_System_Int32_System_Int32_System_Boolean_">AbstractGroupFacetCollector.MergeSegmentResults(Int32, Int32, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_CreateSegmentResult">AbstractGroupFacetCollector.CreateSegmentResult()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_SetScorer_Lucene_Net_Search_Scorer_">AbstractGroupFacetCollector.SetScorer(Scorer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_Collect_System_Int32_">AbstractGroupFacetCollector.Collect(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_">AbstractGroupFacetCollector.SetNextReader(AtomicReaderContext)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.AbstractGroupFacetCollector.html#Lucene_Net_Search_Grouping_AbstractGroupFacetCollector_AcceptsDocsOutOfOrder">AbstractGroupFacetCollector.AcceptsDocsOutOfOrder</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Grouping.Terms.html">Lucene.Net.Search.Grouping.Terms</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Grouping.dll</h6> |
| <h5 id="Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class TermGroupFacetCollector : AbstractGroupFacetCollector, ICollector</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector_CreateTermGroupFacetCollector_System_String_System_String_System_Boolean_Lucene_Net_Util_BytesRef_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector.CreateTermGroupFacetCollector(System.String%2CSystem.String%2CSystem.Boolean%2CLucene.Net.Util.BytesRef%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/Term/TermGroupFacetCollector.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector_CreateTermGroupFacetCollector_" data-uid="Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector.CreateTermGroupFacetCollector*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector_CreateTermGroupFacetCollector_System_String_System_String_System_Boolean_Lucene_Net_Util_BytesRef_System_Int32_" data-uid="Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector.CreateTermGroupFacetCollector(System.String,System.String,System.Boolean,Lucene.Net.Util.BytesRef,System.Int32)">CreateTermGroupFacetCollector(String, String, Boolean, BytesRef, Int32)</h4> |
| <div class="markdown level1 summary"><p>Factory method for creating the right implementation based on the fact whether the facet field contains |
| multiple tokens per documents.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TermGroupFacetCollector CreateTermGroupFacetCollector(string groupField, string facetField, bool facetFieldMultivalued, BytesRef facetPrefix, 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.String</span></td> |
| <td><span class="parametername">groupField</span></td> |
| <td><p>The group field</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">facetField</span></td> |
| <td><p>The facet field</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">facetFieldMultivalued</span></td> |
| <td><p>Whether the facet field has multiple tokens per document</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.BytesRef</span></td> |
| <td><span class="parametername">facetPrefix</span></td> |
| <td><p>The facet prefix a facet entry should start with to be included.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">initialSize</span></td> |
| <td><p>The initial allocation size of the internal int set and group facet list which should roughly |
| match the total number of expected unique groups. Be aware that the heap usage is |
| 4 bytes * initialSize.</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.Terms.TermGroupFacetCollector.html">TermGroupFacetCollector</a></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector.html">TermGroupFacetCollector</a> implementation</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">Lucene.Net.Search.ICollector</span> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_Terms_TermGroupFacetCollector.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.Terms.TermGroupFacetCollector%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/Term/TermGroupFacetCollector.cs/#L31" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
