Class FirstPassGroupingCollector<T>

    • Field Detail

      • reversed

        private final int[] reversed
      • topNGroups

        private final int topNGroups
      • needsScores

        private final boolean needsScores
      • compIDXEnd

        private final int compIDXEnd
      • docBase

        private int docBase
      • spareSlot

        private int spareSlot
    • Constructor Detail

      • FirstPassGroupingCollector

        public FirstPassGroupingCollector​(GroupSelector<T> groupSelector,
                                          Sort groupSort,
                                          int topNGroups)
        Create the first pass collector.
        Parameters:
        groupSelector - a GroupSelector used to defined groups
        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.
    • Method Detail

      • scoreMode

        public ScoreMode scoreMode()
        Description copied from interface: Collector
        Indicates what features are required from the scorer.
      • getTopGroups

        public java.util.Collection<SearchGroup<T>> getTopGroups​(int groupOffset)
                                                          throws java.io.IOException
        Returns top groups, starting from offset. This may return null, if no groups were collected, or if the number of unique groups collected is <= offset.
        Parameters:
        groupOffset - The offset in the collected groups
        Returns:
        top groups, starting from offset
        Throws:
        java.io.IOException
      • isCompetitive

        private boolean isCompetitive​(int doc)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • collect

        public void collect​(int doc)
                     throws java.io.IOException
        Description copied from interface: LeafCollector
        Called once for every document matching a query, with the unbased document number.

        Note: The collection of the current segment can be terminated by throwing a CollectionTerminatedException. In this case, the last docs of the current LeafReaderContext will be skipped and IndexSearcher will swallow the exception and continue collection with the next leaf.

        Note: This is called in an inner search loop. For good search performance, implementations of this method should not call StoredFields.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

        Specified by:
        collect in interface LeafCollector
        Specified by:
        collect in class SimpleCollector
        Throws:
        java.io.IOException
      • buildSortedSet

        private void buildSortedSet()
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • getGroupSelector

        public GroupSelector<T> getGroupSelector()
        Returns:
        the GroupSelector used for this Collector