|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.lucene.search.Collector
org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE>
public abstract class AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE>
FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits. This pass gathers the top N sorted groups. 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.
| Constructor Summary | |
|---|---|
AbstractFirstPassGroupingCollector(org.apache.lucene.search.Sort groupSort,
int topNGroups)
Create the first pass collector. |
|
| Method Summary | |
|---|---|
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)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
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 occur| Method Detail |
|---|
public 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.CollectorIOException
public void collect(int doc)
throws IOException
collect in class org.apache.lucene.search.CollectorIOExceptionpublic 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.CollectorIOExceptionprotected abstract GROUP_VALUE_TYPE getDocGroupValue(int doc)
doc - The specified doc
protected 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
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||