Class FilterSpans

Direct Known Subclasses:
PayloadScoreQuery.PayloadSpans

public abstract class FilterSpans extends Spans
A Spans implementation wrapping another spans instance, allowing to filter spans matches easily by implementing accept(org.apache.lucene.queries.spans.Spans)
  • Field Details

    • in

      protected final Spans in
      The wrapped spans instance.
    • atFirstInCurrentDoc

      private boolean atFirstInCurrentDoc
    • startPos

      private int startPos
  • Constructor Details

    • FilterSpans

      protected FilterSpans(Spans in)
      Wrap the given Spans.
  • Method Details

    • accept

      protected abstract FilterSpans.AcceptStatus accept(Spans candidate) throws IOException
      Returns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.
      Throws:
      IOException
    • nextDoc

      public final int nextDoc() throws IOException
      Description copied from class: DocIdSetIterator
      Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
      NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
      Specified by:
      nextDoc in class DocIdSetIterator
      Throws:
      IOException
    • advance

      public final int advance(int target) throws IOException
      Description copied from class: DocIdSetIterator
      Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

      The behavior of this method is undefined when called with target ≤ current , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

      When target > current it behaves as if written:

       int advance(int target) {
         int doc;
         while ((doc = nextDoc()) < target) {
         }
         return doc;
       }
       
      Some implementations are considerably more efficient than that.

      NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

      Specified by:
      advance in class DocIdSetIterator
      Throws:
      IOException
    • docID

      public final int docID()
      Description copied from class: DocIdSetIterator
      Returns the following:
      Specified by:
      docID in class DocIdSetIterator
    • nextStartPosition

      public final int nextStartPosition() throws IOException
      Description copied from class: Spans
      Returns the next start position for the current doc. There is always at least one start/end position per doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.
      Specified by:
      nextStartPosition in class Spans
      Throws:
      IOException
    • startPosition

      public final int startPosition()
      Description copied from class: Spans
      Returns the start position in the current doc, or -1 when Spans.nextStartPosition() was not yet called on the current doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.
      Specified by:
      startPosition in class Spans
    • endPosition

      public final int endPosition()
      Description copied from class: Spans
      Returns the end position for the current start position, or -1 when Spans.nextStartPosition() was not yet called on the current doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.
      Specified by:
      endPosition in class Spans
    • width

      public int width()
      Description copied from class: Spans
      Return the width of the match, which is typically used to sloppy freq. It is only legal to call this method when the iterator is on a valid doc ID and positioned. The return value must be positive, and lower values means that the match is better.
      Specified by:
      width in class Spans
    • collect

      public void collect(SpanCollector collector) throws IOException
      Description copied from class: Spans
      Collect postings data from the leaves of the current Spans.

      This method should only be called after Spans.nextStartPosition(), and before Spans.NO_MORE_POSITIONS has been reached.

      Specified by:
      collect in class Spans
      Parameters:
      collector - a SpanCollector
      Throws:
      IOException
    • cost

      public final long cost()
      Description copied from class: DocIdSetIterator
      Returns the estimated cost of this DocIdSetIterator.

      This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

      Specified by:
      cost in class DocIdSetIterator
    • toString

      public String toString()
      Overrides:
      toString in class Spans
    • asTwoPhaseIterator

      public final TwoPhaseIterator asTwoPhaseIterator()
      Description copied from class: Spans
      Optional method: Return a TwoPhaseIterator view of this Scorer. A return value of null indicates that two-phase iteration is not supported.
      Overrides:
      asTwoPhaseIterator in class Spans
      See Also:
    • positionsCost

      public float positionsCost()
      Description copied from class: Spans
      Return an estimation of the cost of using the positions of this Spans for any single document, but only after Spans.asTwoPhaseIterator() returned null. Otherwise this method should not be called. The returned value is independent of the current document.
      Specified by:
      positionsCost in class Spans
    • twoPhaseCurrentDocMatches

      private final boolean twoPhaseCurrentDocMatches() throws IOException
      Returns true if the current document matches.

      This is called during two-phase processing.

      Throws:
      IOException