|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Collector org.apache.lucene.search.grouping.AllGroupsCollector
public class AllGroupsCollector
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.
Implementation detail: an int hash set (SentinelIntSet) is used to detect if a group is already added to the total count. For each segment the int set is cleared and filled with previous counted groups that occur in the new segment.
Constructor Summary | |
---|---|
AllGroupsCollector(String groupField)
Constructs a AllGroupsCollector . |
|
AllGroupsCollector(String groupField,
int initialSize)
Expert: Constructs a AllGroupsCollector |
Method Summary | |
---|---|
boolean |
acceptsDocsOutOfOrder()
|
void |
collect(int doc)
|
int |
getGroupCount()
Returns the total number of groups for the executed search. |
Collection<String> |
getGroups()
Returns the group values This is an unordered collections of group values. |
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 AllGroupsCollector(String groupField, int initialSize)
AllGroupsCollector
groupField
- The field to group byinitialSize
- The initial allocation size of the
internal int set and group list
which should roughly match the total
number of expected unique groups. Be aware that the
heap usage is 4 bytes * initialSize.public AllGroupsCollector(String groupField)
AllGroupsCollector
. This sets the
initial allocation size for the internal int set and group
list to 128.
groupField
- The field to group byMethod Detail |
---|
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 int getGroupCount()
getGroups().size()
public Collection<String> getGroups()
String
representing a group value.
public void setNextReader(org.apache.lucene.index.IndexReader reader, int docBase) throws IOException
setNextReader
in class org.apache.lucene.search.Collector
IOException
public boolean acceptsDocsOutOfOrder()
acceptsDocsOutOfOrder
in class org.apache.lucene.search.Collector
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |