Class AbstractAllGroupHeadsCollector_GroupHead

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.

The group head contains a group value with its associated most relevant document id.

Inheritance
System.Object
AbstractAllGroupHeadsCollector_GroupHead
FunctionAllGroupHeadsCollector.GroupHead
Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public abstract class AbstractAllGroupHeadsCollector_GroupHead : object
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.

Constructors

| Improve this Doc View Source

AbstractAllGroupHeadsCollector_GroupHead(Int32)

Declaration
protected AbstractAllGroupHeadsCollector_GroupHead(int doc)
Parameters
Type Name Description
System.Int32 doc

Properties

| Improve this Doc View Source

Doc

Declaration
public int Doc { get; protected set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Compare(Int32, Int32)

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
System.Int32 compIDX

The comparer index of the specified comparer.
System.Int32 doc

The specified document.
Returns
Type Description
System.Int32

-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.
| Improve this Doc View Source

UpdateDocHead(Int32)

Updates the current most relevant document with the specified document.

Declaration
public abstract void UpdateDocHead(int doc)
Parameters
Type Name Description
System.Int32 doc

The specified document