Class LeafBucketCollector

java.lang.Object
org.elasticsearch.search.aggregations.LeafBucketCollector
All Implemented Interfaces:
org.apache.lucene.search.LeafCollector
Direct Known Subclasses:
LeafBucketCollectorBase, ProfilingLeafBucketCollector

public abstract class LeafBucketCollector
extends java.lang.Object
implements org.apache.lucene.search.LeafCollector
Per-leaf bucket collector.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static LeafBucketCollector NO_OP_COLLECTOR  
  • Constructor Summary

    Constructors 
    Constructor Description
    LeafBucketCollector()  
  • Method Summary

    Modifier and Type Method Description
    void collect​(int doc)  
    abstract void collect​(int doc, long bucket)
    Collect the given doc in the given bucket.
    void setScorer​(org.apache.lucene.search.Scorable scorer)  
    static LeafBucketCollector wrap​(java.lang.Iterable<LeafBucketCollector> collectors)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

  • Method Details

    • wrap

      public static LeafBucketCollector wrap​(java.lang.Iterable<LeafBucketCollector> collectors)
    • collect

      public abstract void collect​(int doc, long bucket) throws java.io.IOException
      Collect the given doc in the given bucket.
      Throws:
      java.io.IOException
    • collect

      public final void collect​(int doc) throws java.io.IOException
      Specified by:
      collect in interface org.apache.lucene.search.LeafCollector
      Throws:
      java.io.IOException
    • setScorer

      public void setScorer​(org.apache.lucene.search.Scorable scorer) throws java.io.IOException
      Specified by:
      setScorer in interface org.apache.lucene.search.LeafCollector
      Throws:
      java.io.IOException