Class AbstractSecondPassGroupingCollector<TGroupValue>

SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs. This pass gathers the top N documents per top group computed from the first pass. Concrete subclasses define what a group is and how it is internally collected.

See org.apache.lucene.search.grouping for more details including a full code example.

Note

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

Inheritance
System.Object
AbstractSecondPassGroupingCollector<TGroupValue>
FunctionSecondPassGroupingCollector<TMutableValue>
TermSecondPassGroupingCollector
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 AbstractSecondPassGroupingCollector<TGroupValue> : IAbstractSecondPassGroupingCollector<TGroupValue>, ICollector
Type Parameters
Name Description
TGroupValue

Constructors

| Improve this Doc View Source

AbstractSecondPassGroupingCollector(IEnumerable<ISearchGroup<TGroupValue>>, Sort, Sort, Int32, Boolean, Boolean, Boolean)

Declaration
protected AbstractSecondPassGroupingCollector(IEnumerable<ISearchGroup<TGroupValue>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, bool getScores, bool getMaxScores, bool fillSortFields)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ISearchGroup<TGroupValue>> groups
Lucene.Net.Search.Sort groupSort
Lucene.Net.Search.Sort withinGroupSort
System.Int32 maxDocsPerGroup
System.Boolean getScores
System.Boolean getMaxScores
System.Boolean fillSortFields

Fields

| Improve this Doc View Source

m_groupDocs

Declaration
protected AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue>[] m_groupDocs
Field Value
Type Description
AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue>[]
| Improve this Doc View Source

m_groupMap

Declaration
protected readonly IDictionary<TGroupValue, AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue>> m_groupMap
Field Value
Type Description
System.Collections.Generic.IDictionary<TGroupValue, AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue>>

Properties

| Improve this Doc View Source

AcceptsDocsOutOfOrder

Declaration
public virtual bool AcceptsDocsOutOfOrder { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

Collect(Int32)

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

GetTopGroups(Int32)

Declaration
public virtual ITopGroups<TGroupValue> GetTopGroups(int withinGroupOffset)
Parameters
Type Name Description
System.Int32 withinGroupOffset
Returns
Type Description
ITopGroups<TGroupValue>
| Improve this Doc View Source

RetrieveGroup(Int32)

Returns the group the specified doc belongs to or null if no group could be retrieved.

Declaration
protected abstract AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue> RetrieveGroup(int doc)
Parameters
Type Name Description
System.Int32 doc

The specified doc
Returns
Type Description
AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue>

the group the specified doc belongs to or null if no group could be retrieved
Exceptions
Type Condition
System.IO.IOException

If an I/O related error occurred
| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

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

SetScorer(Scorer)

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

Implements

Lucene.Net.Search.ICollector