Class AbstractAllGroupHeadsCollector<GH>

This collector specializes in collecting the most relevant document (group head) for each group that match the query.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
System.Object
AbstractAllGroupHeadsCollector
AbstractAllGroupHeadsCollector<GH>
FunctionAllGroupHeadsCollector
TermAllGroupHeadsCollector<GH>
Implements
Lucene.Net.Search.ICollector
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public abstract class AbstractAllGroupHeadsCollector<GH> : AbstractAllGroupHeadsCollector, ICollector where GH : AbstractAllGroupHeadsCollector_GroupHead
Type Parameters
Name Description
GH

Constructors

| Improve this Doc View Source

AbstractAllGroupHeadsCollector(Int32)

Declaration
protected AbstractAllGroupHeadsCollector(int numberOfSorts)
Parameters
Type Name Description
System.Int32 numberOfSorts

Fields

| Improve this Doc View Source

m_compIDXEnd

Declaration
protected readonly int m_compIDXEnd
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_reversed

Declaration
protected readonly int[] m_reversed
Field Value
Type Description
System.Int32[]
| Improve this Doc View Source

m_temporalResult

Declaration
protected readonly AbstractAllGroupHeadsCollector<GH>.TemporalResult m_temporalResult
Field Value
Type Description
AbstractAllGroupHeadsCollector.TemporalResult<>

Properties

| Improve this Doc View Source

AcceptsDocsOutOfOrder

Declaration
public override bool AcceptsDocsOutOfOrder { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

CollectedGroupHeads

Returns the collected group heads. Subsequent calls should return the same group heads.

Declaration
protected abstract ICollection<GH> CollectedGroupHeads { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<GH>

the collected group heads
| Improve this Doc View Source

GroupHeadsCount

The number of group heads found for a query. LUCENENET NOTE: This was groupHeadsSize() in Lucene

Declaration
public override int GroupHeadsCount { get; }
Property Value
Type Description
System.Int32

the number of group heads found for a query.
Overrides

Methods

| Improve this Doc View Source

Collect(Int32)

Declaration
public override void Collect(int doc)
Parameters
Type Name Description
System.Int32 doc
Overrides
| Improve this Doc View Source

RetrieveGroupHeadAndAddIfNotExist(Int32)

Returns the group head and puts it into AbstractAllGroupHeadsCollector<GH>.TemporalResult. If the group head wasn't encountered before then it will be added to the collected group heads.

The Stop property will be true if the group head wasn't encountered before otherwise false.

Declaration
protected abstract override void RetrieveGroupHeadAndAddIfNotExist(int doc)
Parameters
Type Name Description
System.Int32 doc

The document to retrieve the group head for.
Overrides
Exceptions
Type Condition
System.IO.IOException

If I/O related errors occur
| Improve this Doc View Source

RetrieveGroupHeads()

Declaration
public override int[] RetrieveGroupHeads()
Returns
Type Description
System.Int32[]

an int array containing all group heads. The size of the array is equal to number of collected unique groups.
Overrides
| Improve this Doc View Source

RetrieveGroupHeads(Int32)

Declaration
public override FixedBitSet RetrieveGroupHeads(int maxDoc)
Parameters
Type Name Description
System.Int32 maxDoc

The maxDoc of the top level Lucene.Net.Index.IndexReader
Returns
Type Description
Lucene.Net.Util.FixedBitSet

a Lucene.Net.Util.FixedBitSet containing all group heads.
Overrides

Implements

Lucene.Net.Search.ICollector