Class SpanPositionCheckQuery

All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
SpanNearPayloadCheckQuery, SpanPayloadCheckQuery, SpanPositionRangeQuery

public abstract class SpanPositionCheckQuery extends SpanQuery implements Cloneable
Base class for filtering a SpanQuery based on the position of a match.
  • Field Details

  • Constructor Details

    • SpanPositionCheckQuery

      public SpanPositionCheckQuery(SpanQuery match)
  • Method Details

    • getMatch

      public SpanQuery getMatch()
      Returns:
      the SpanQuery whose matches are filtered.
    • getField

      public String getField()
      Description copied from class: SpanQuery
      Returns the name of the field matched by this query.

      Note that this may return null if the query matches no terms.

      Specified by:
      getField in class SpanQuery
    • extractTerms

      public void extractTerms(Set<Term> terms)
      Description copied from class: Query
      Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.
      Overrides:
      extractTerms in class Query
    • acceptPosition

      protected abstract SpanPositionCheckQuery.AcceptStatus acceptPosition(Spans spans) throws IOException
      Implementing classes are required to return whether the current position is a match for the passed in "match" SpanQuery. This is only called if the underlying Spans.next() for the match is successful
      Parameters:
      spans - The Spans instance, positioned at the spot to check
      Returns:
      whether the match is accepted, rejected, or rejected and should move to the next doc.
      Throws:
      IOException
      See Also:
    • getSpans

      public Spans getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts) throws IOException
      Description copied from class: SpanQuery
      Expert: Returns the matches for this query in an index. Used internally to search for spans.
      Specified by:
      getSpans in class SpanQuery
      Throws:
      IOException
    • rewrite

      public Query rewrite(IndexReader reader) throws IOException
      Description copied from class: Query
      Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
      Overrides:
      rewrite in class Query
      Throws:
      IOException