Class TermFirstPassGroupingCollector

Concrete implementation of AbstractFirstPassGroupingCollector<TGroupValue> that groups based on field values and more specifically uses Lucene.Net.Index.SortedDocValues to collect groups.

Note

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

Inheritance
System.Object
AbstractFirstPassGroupingCollector<Lucene.Net.Util.BytesRef>
TermFirstPassGroupingCollector
Implements
IAbstractFirstPassGroupingCollector<Lucene.Net.Util.BytesRef>
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.Terms
Assembly: Lucene.Net.Grouping.dll
Syntax
public class TermFirstPassGroupingCollector : AbstractFirstPassGroupingCollector<BytesRef>, IAbstractFirstPassGroupingCollector<BytesRef>, ICollector

Constructors

| Improve this Doc View Source

TermFirstPassGroupingCollector(String, Sort, Int32)

Create the first pass collector.

Declaration
public TermFirstPassGroupingCollector(string groupField, Sort groupSort, int topNGroups)
Parameters
Type Name Description
System.String groupField

The field used to group documents. This field must be single-valued and indexed (Lucene.Net.Search.FieldCache is used to access its value per-document).
Lucene.Net.Search.Sort groupSort

The Lucene.Net.Search.Sort used to sort the groups. The top sorted document within each group according to groupSort, determines how that group sorts against other groups. This must be non-null, ie, if you want to groupSort by relevance use RELEVANCE.
System.Int32 topNGroups

How many top groups to keep.
Exceptions
Type Condition
System.IO.IOException

When I/O related errors occur

Methods

| Improve this Doc View Source

CopyDocGroupValue(BytesRef, BytesRef)

Declaration
protected override BytesRef CopyDocGroupValue(BytesRef groupValue, BytesRef reuse)
Parameters
Type Name Description
Lucene.Net.Util.BytesRef groupValue
Lucene.Net.Util.BytesRef reuse
Returns
Type Description
Lucene.Net.Util.BytesRef
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.BytesRef>.CopyDocGroupValue(Lucene.Net.Util.BytesRef, Lucene.Net.Util.BytesRef)
| Improve this Doc View Source

GetDocGroupValue(Int32)

Declaration
protected override BytesRef GetDocGroupValue(int doc)
Parameters
Type Name Description
System.Int32 doc
Returns
Type Description
Lucene.Net.Util.BytesRef
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.BytesRef>.GetDocGroupValue(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
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.BytesRef>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements

Lucene.Net.Search.ICollector