Google Git
Sign in
apache / lucenenet-site / 5ff971ba7cc570e29ca8a7f21ffcd5b2651be54b / . / docs / 4.8.0-beta00010 / api / grouping / Lucene.Net.Search.Grouping.IGroupDocs-1.html
blob: 1ba5982d5f3a3f9d1ac9433e649b4ea59beea009 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IGroupDocs&lt;TGroupValue&gt;
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IGroupDocs&lt;TGroupValue&gt;
| 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.IGroupDocs`1">
<h1 id="Lucene_Net_Search_Grouping_IGroupDocs_1" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1" class="text-break">Interface IGroupDocs&lt;TGroupValue&gt;
</h1>
<div class="markdown level0 summary"><p>LUCENENET specific interface used to apply covariance to TGroupValue
to simulate Java&apos;s wildcard generics.</p>
</div>
<div class="markdown level0 conceptual"></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_IGroupDocs_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IGroupDocs&lt;out TGroupValue&gt;</code></pre>
</div>
<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>
<h3 id="properties">Properties
</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_IGroupDocs_1_GroupSortValues.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.GroupSortValues%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/GroupDocs.cs/#L115">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_GroupSortValues_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.GroupSortValues*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_GroupSortValues" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.GroupSortValues">GroupSortValues</h4>
<div class="markdown level1 summary"><p>Matches the groupSort passed to <a class="xref" href="Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector-1.html">AbstractFirstPassGroupingCollector&lt;TGroupValue&gt;</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">object[] GroupSortValues { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Object</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_IGroupDocs_1_GroupValue.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.GroupValue%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/GroupDocs.cs/#L88">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_GroupValue_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.GroupValue*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_GroupValue" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.GroupValue">GroupValue</h4>
<div class="markdown level1 summary"><p>The groupField value for all docs in this group; this
may be null if hits did not have the groupField. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">TGroupValue GroupValue { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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">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_IGroupDocs_1_MaxScore.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.MaxScore%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/GroupDocs.cs/#L93">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_MaxScore_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.MaxScore*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_MaxScore" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.MaxScore">MaxScore</h4>
<div class="markdown level1 summary"><p>Max score in this group</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">float MaxScore { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Single</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_IGroupDocs_1_Score.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.Score%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/GroupDocs.cs/#L98">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_Score_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.Score*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_Score" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.Score">Score</h4>
<div class="markdown level1 summary"><p>Overall aggregated score of this group (currently only set by join queries). </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">float Score { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Single</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_IGroupDocs_1_ScoreDocs.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.ScoreDocs%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/GroupDocs.cs/#L104">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_ScoreDocs_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.ScoreDocs*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_ScoreDocs" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.ScoreDocs">ScoreDocs</h4>
<div class="markdown level1 summary"><p>Hits; this may be <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FieldDoc.html">FieldDoc</a> instances if the
withinGroupSort sorted by fields. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">ScoreDoc[] ScoreDocs { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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="http://localhost:8080/api/core/Lucene.Net.Search.ScoreDoc.html">ScoreDoc</a>[]</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_IGroupDocs_1_TotalHits.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%601.TotalHits%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/GroupDocs.cs/#L110">View Source</a>
</span>
<a id="Lucene_Net_Search_Grouping_IGroupDocs_1_TotalHits_" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.TotalHits*"></a>
<h4 id="Lucene_Net_Search_Grouping_IGroupDocs_1_TotalHits" data-uid="Lucene.Net.Search.Grouping.IGroupDocs`1.TotalHits">TotalHits</h4>
<div class="markdown level1 summary"><p>Total hits within this group</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int TotalHits { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Int32</span></td>
<td></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_IGroupDocs_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Grouping.IGroupDocs%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" 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/GroupDocs.cs/#L82" 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>