Class FunctionAllGroupHeadsCollector.GroupHead
Holds current head document for a single group.
Note
This API is experimental and might change in incompatible ways in the next release.
Inheritance
Inherited Members
Namespace: Lucene.Net.Search.Grouping.Function
Assembly: Lucene.Net.Grouping.dll
Syntax
public class FunctionAllGroupHeadsCollector.GroupHead : AbstractAllGroupHeadsCollector_GroupHeadProperties
GroupValue
Holds current head document for a single group.
Note
This API is experimental and might change in incompatible ways in the next release.
Declaration
public MutableValue GroupValue { get; }Property Value
| Type | Description |
|---|---|
| MutableValue |
Methods
Compare(int, int)
Compares the specified document for a specified comparer against the current most relevant document.
Declaration
public override int Compare(int compIDX, int doc)Parameters
| Type | Name | Description |
|---|---|---|
| int | compIDX | The comparer index of the specified comparer. |
| int | doc | The specified document. |
Returns
| Type | Description |
|---|---|
| int | -1 if the specified document wasn't competitive against the current most relevant document, 1 if the specified document was competitive against the current most relevant document. Otherwise 0. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| IOException | If I/O related errors occur |
UpdateDocHead(int)
Updates the current most relevant document with the specified document.
Declaration
public override void UpdateDocHead(int doc)Parameters
| Type | Name | Description |
|---|---|---|
| int | doc | The specified document |
Overrides
Exceptions
| Type | Condition |
|---|---|
| IOException | If I/O related errors occur |