Package org.apache.lucene.search

Class FilterLeafCollector

java.lang.Object
org.apache.lucene.search.FilterLeafCollector
All Implemented Interfaces:
LeafCollector
public abstract class FilterLeafCollector extends Object implements LeafCollector
LeafCollector delegator.
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Field Details

  • Constructor Details

    • FilterLeafCollector

      public FilterLeafCollector(LeafCollector in)
      Sole constructor.

  • Method Details

    • setScorer

      public void setScorer(Scorable scorer) throws IOException
      Description copied from interface: LeafCollector
      Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.
      Specified by:
      setScorer in interface LeafCollector
      Throws:
      IOException

    • collect

      public void collect(int doc) throws 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
      Throws:
      IOException

    • finish

      public void finish() throws IOException
      Description copied from interface: LeafCollector
      Hook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when a CollectionTerminatedException is thrown. This is typically useful to compile data that has been collected on this leaf, e.g. to convert facet counts on leaf ordinals to facet counts on global ordinals. The default implementation does nothing.

      Note: It can be assumed that this method will only be called once per LeafCollector instance.

      Specified by:
      finish in interface LeafCollector
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object