Interface LeafCollector

    • Method Detail

      • setScorer

        void setScorer​(Scorable scorer)
                throws java.io.IOException
        Called before successive calls to collect(int). Implementations that need the score of the current document (passed-in to collect(int)), should save the passed-in Scorer and call scorer.score() when needed.
        Throws:
        java.io.IOException
      • collect

        void collect​(int doc)
              throws java.io.IOException
        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 IndexSearcher.doc(int) or IndexReader.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

        Throws:
        java.io.IOException
      • competitiveIterator

        default DocIdSetIterator competitiveIterator()
                                              throws java.io.IOException
        Optionally returns an iterator over competitive documents. Collectors should delegate this method to their comparators if their comparators provide the skipping functionality over non-competitive docs. The default is to return null which is interpreted as the collector provide any competitive iterator.
        Throws:
        java.io.IOException