Class FunctionAllGroupHeadsCollector

An implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping by Lucene.Net.Queries.Function.ValueSource.

Note

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

Inheritance
System.Object
AbstractAllGroupHeadsCollector
AbstractAllGroupHeadsCollector<FunctionAllGroupHeadsCollector.GroupHead>
FunctionAllGroupHeadsCollector
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.Function
Assembly: Lucene.Net.Grouping.dll
Syntax
public class FunctionAllGroupHeadsCollector : AbstractAllGroupHeadsCollector<FunctionAllGroupHeadsCollector.GroupHead>, ICollector

Constructors

| Improve this Doc View Source

FunctionAllGroupHeadsCollector(ValueSource, IDictionary, Sort)

Constructs a FunctionAllGroupHeadsCollector instance.

Declaration
public FunctionAllGroupHeadsCollector(ValueSource groupBy, IDictionary vsContext, Sort sortWithinGroup)
Parameters
Type Name Description
Lucene.Net.Queries.Function.ValueSource groupBy

The Lucene.Net.Queries.Function.ValueSource to group by
System.Collections.IDictionary vsContext

The Lucene.Net.Queries.Function.ValueSource context
Lucene.Net.Search.Sort sortWithinGroup

The sort within a group

Properties

| Improve this Doc View Source

CollectedGroupHeads

Declaration
protected override ICollection<FunctionAllGroupHeadsCollector.GroupHead> CollectedGroupHeads { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<FunctionAllGroupHeadsCollector.GroupHead>
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector<Lucene.Net.Search.Grouping.Function.FunctionAllGroupHeadsCollector.GroupHead>.CollectedGroupHeads

Methods

| Improve this Doc View Source

RetrieveGroupHeadAndAddIfNotExist(Int32)

Declaration
protected override void RetrieveGroupHeadAndAddIfNotExist(int doc)
Parameters
Type Name Description
System.Int32 doc
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector<Lucene.Net.Search.Grouping.Function.FunctionAllGroupHeadsCollector.GroupHead>.RetrieveGroupHeadAndAddIfNotExist(System.Int32)
| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

Declaration
public override void SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
Lucene.Net.Index.AtomicReaderContext context
Overrides
| Improve this Doc View Source

SetScorer(Scorer)

Declaration
public override void SetScorer(Scorer scorer)
Parameters
Type Name Description
Lucene.Net.Search.Scorer scorer
Overrides

Implements

Lucene.Net.Search.ICollector