Package org.apache.lucene.search.grouping

Class AbstractAllGroupsCollector<GROUP_VALUE_TYPE>

  • Direct Known Subclasses:
    TermAllGroupsCollector
    public abstract class AbstractAllGroupsCollector<GROUP_VALUE_TYPE>
extends org.apache.lucene.search.Collector
    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.

    This is an abstract version. Concrete implementations define what a group actually is and how it is internally collected.

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

    • Constructor Detail

      • AbstractAllGroupsCollector

        public AbstractAllGroupsCollector()

    • 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 abstract Collection<GROUP_VALUE_TYPE> getGroups()
        Returns the group values

        This is an unordered collections of group values. For each group that matched the query there is a BytesRef representing a group value.

        Returns:
        the group values

      • setScorer

        public void setScorer​(org.apache.lucene.search.Scorer scorer)
               throws IOException
        Specified by:
        setScorer in class org.apache.lucene.search.Collector
        Throws:
        IOException

      • acceptsDocsOutOfOrder

        public boolean acceptsDocsOutOfOrder()
        Specified by:
        acceptsDocsOutOfOrder in class org.apache.lucene.search.Collector