Module org.apache.lucene.queries
Package org.apache.lucene.queries.spans

Interface SpanCollector

All Known Implementing Classes:
PayloadScoreQuery.PayloadSpans, PayloadSpanCollector, PhraseHelper.OffsetSpanCollector, SpanPayloadCheckQuery.PayloadChecker
public interface SpanCollector
An interface defining the collection of postings information from the leaves of a Spans

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    collectLeaf(PostingsEnum postings, int position, Term term)
    Collect information from postings
    void
    reset()
    Call to indicate that the driving Spans has moved to a new position

  • Method Details

    • collectLeaf

      void collectLeaf(PostingsEnum postings, int position, Term term) throws IOException
      Collect information from postings
      Parameters:
      postings - a PostingsEnum
      position - the position of the PostingsEnum
      term - the Term for this postings list
      Throws:
      IOException - on error

    • reset

      void reset()
      Call to indicate that the driving Spans has moved to a new position