public abstract class AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE>
extends org.apache.lucene.search.Collector
See org.apache.lucene.search.grouping
for more
details including a full code example.
Constructor and Description |
---|
AbstractFirstPassGroupingCollector(org.apache.lucene.search.Sort groupSort,
int topNGroups)
Create the first pass collector.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsDocsOutOfOrder() |
void |
collect(int doc) |
protected abstract GROUP_VALUE_TYPE |
copyDocGroupValue(GROUP_VALUE_TYPE groupValue,
GROUP_VALUE_TYPE reuse)
Returns a copy of the specified group value by creating a new instance and copying the value from the specified
groupValue in the new instance.
|
protected abstract GROUP_VALUE_TYPE |
getDocGroupValue(int doc)
Returns the group value for the specified doc.
|
Collection<SearchGroup<GROUP_VALUE_TYPE>> |
getTopGroups(int groupOffset,
boolean fillFields)
Returns top groups, starting from offset.
|
void |
setNextReader(org.apache.lucene.index.IndexReader reader,
int docBase) |
void |
setScorer(org.apache.lucene.search.Scorer scorer) |
public AbstractFirstPassGroupingCollector(org.apache.lucene.search.Sort groupSort, int topNGroups) throws IOException
groupSort
- The 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
Sort.RELEVANCE.topNGroups
- How many top groups to keep.IOException
- If I/O related errors occurpublic Collection<SearchGroup<GROUP_VALUE_TYPE>> getTopGroups(int groupOffset, boolean fillFields)
groupOffset
- The offset in the collected groupsfillFields
- Whether to fill to SearchGroup.sortValues
public void setScorer(org.apache.lucene.search.Scorer scorer) throws IOException
setScorer
in class org.apache.lucene.search.Collector
IOException
public void collect(int doc) throws IOException
collect
in class org.apache.lucene.search.Collector
IOException
public boolean acceptsDocsOutOfOrder()
acceptsDocsOutOfOrder
in class org.apache.lucene.search.Collector
public void setNextReader(org.apache.lucene.index.IndexReader reader, int docBase) throws IOException
setNextReader
in class org.apache.lucene.search.Collector
IOException
protected abstract GROUP_VALUE_TYPE getDocGroupValue(int doc)
doc
- The specified docprotected abstract GROUP_VALUE_TYPE copyDocGroupValue(GROUP_VALUE_TYPE groupValue, GROUP_VALUE_TYPE reuse)
groupValue
- The group value to copyreuse
- Optionally a reuse instance to prevent a new instance creation