Class AbstractAllGroupHeadsCollector_GroupHead
Represents a group head. A group head is the most relevant document for a particular group. The relevancy is usually based on the sort.
The group head contains a group value with its associated most relevant document id.
Inheritance
Inherited Members
Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public abstract class AbstractAllGroupHeadsCollector_GroupHeadRemarks
LUCENENET: moved this class from being a nested class of AbstractAllGroupHeadsCollector<GH>, made it non-generic so the generic closing type doesn't need to be specified in classes that use AbstractAllGroupHeadsCollector_GroupHead as a generic closing type, and renamed it from GroupHead to AbstractAllGroupHeadsCollector_GroupHead to avoid naming conflicts with nested classes named GroupHead in derived classes of AbstractAllGroupHeadsCollector.
Constructors
AbstractAllGroupHeadsCollector_GroupHead(int)
Represents a group head. A group head is the most relevant document for a particular group. The relevancy is usually based on the sort.
The group head contains a group value with its associated most relevant document id.
Declaration
protected AbstractAllGroupHeadsCollector_GroupHead(int doc)Parameters
| Type | Name | Description |
|---|---|---|
| int | doc |
Remarks
LUCENENET: moved this class from being a nested class of AbstractAllGroupHeadsCollector<GH>, made it non-generic so the generic closing type doesn't need to be specified in classes that use AbstractAllGroupHeadsCollector_GroupHead as a generic closing type, and renamed it from GroupHead to AbstractAllGroupHeadsCollector_GroupHead to avoid naming conflicts with nested classes named GroupHead in derived classes of AbstractAllGroupHeadsCollector.
Properties
Doc
Represents a group head. A group head is the most relevant document for a particular group. The relevancy is usually based on the sort.
The group head contains a group value with its associated most relevant document id.
Declaration
public int Doc { get; protected set; }Property Value
| Type | Description |
|---|---|
| int |
Remarks
LUCENENET: moved this class from being a nested class of AbstractAllGroupHeadsCollector<GH>, made it non-generic so the generic closing type doesn't need to be specified in classes that use AbstractAllGroupHeadsCollector_GroupHead as a generic closing type, and renamed it from GroupHead to AbstractAllGroupHeadsCollector_GroupHead to avoid naming conflicts with nested classes named GroupHead in derived classes of AbstractAllGroupHeadsCollector.
Methods
Compare(int, int)
Compares the specified document for a specified comparer against the current most relevant document.
Declaration
public abstract 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. |
Remarks
LUCENENET: moved this class from being a nested class of AbstractAllGroupHeadsCollector<GH>, made it non-generic so the generic closing type doesn't need to be specified in classes that use AbstractAllGroupHeadsCollector_GroupHead as a generic closing type, and renamed it from GroupHead to AbstractAllGroupHeadsCollector_GroupHead to avoid naming conflicts with nested classes named GroupHead in derived classes of AbstractAllGroupHeadsCollector.
Exceptions
| Type | Condition |
|---|---|
| IOException | If I/O related errors occur |
UpdateDocHead(int)
Updates the current most relevant document with the specified document.
Declaration
public abstract void UpdateDocHead(int doc)Parameters
| Type | Name | Description |
|---|---|---|
| int | doc | The specified document |
Remarks
LUCENENET: moved this class from being a nested class of AbstractAllGroupHeadsCollector<GH>, made it non-generic so the generic closing type doesn't need to be specified in classes that use AbstractAllGroupHeadsCollector_GroupHead as a generic closing type, and renamed it from GroupHead to AbstractAllGroupHeadsCollector_GroupHead to avoid naming conflicts with nested classes named GroupHead in derived classes of AbstractAllGroupHeadsCollector.
Exceptions
| Type | Condition |
|---|---|
| IOException | If I/O related errors occur |