Class AllGroupsCollector<T>
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- org.apache.lucene.search.grouping.AllGroupsCollector<T>
-
- All Implemented Interfaces:
Collector
,LeafCollector
public class AllGroupsCollector<T> extends SimpleCollector
A collector that collects all groups that match the query. Only the group value is collected, and the order is undefined. This collector does not determine the most relevant document of a group.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description AllGroupsCollector(GroupSelector<T> groupSelector)
Create a new AllGroupsCollector
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
collect(int doc)
protected void
doSetNextReader(LeafReaderContext context)
int
getGroupCount()
Returns the total number of groups for the executed search.Collection<T>
getGroups()
Returns the group valuesScoreMode
scoreMode()
void
setScorer(Scorable scorer)
-
Methods inherited from class org.apache.lucene.search.SimpleCollector
getLeafCollector
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator, finish
-
-
-
-
Constructor Detail
-
AllGroupsCollector
public AllGroupsCollector(GroupSelector<T> groupSelector)
Create a new AllGroupsCollector- Parameters:
groupSelector
- the GroupSelector to determine groups
-
-
Method Detail
-
getGroupCount
public int getGroupCount()
Returns the total number of groups for the executed search. This is a convenience method. The following code snippet has the same effect:getGroups().size()
- Returns:
- The total number of groups for the executed search
-
getGroups
public Collection<T> getGroups()
Returns the group valuesThis is an unordered collections of group values.
- Returns:
- the group values
-
setScorer
public void setScorer(Scorable scorer) throws IOException
- Specified by:
setScorer
in interfaceLeafCollector
- Overrides:
setScorer
in classSimpleCollector
- Throws:
IOException
-
doSetNextReader
protected void doSetNextReader(LeafReaderContext context) throws IOException
- Overrides:
doSetNextReader
in classSimpleCollector
- Throws:
IOException
-
collect
public void collect(int doc) throws IOException
- Specified by:
collect
in interfaceLeafCollector
- Specified by:
collect
in classSimpleCollector
- Throws:
IOException
-
scoreMode
public ScoreMode scoreMode()
-
-