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

Class ConjunctionSpans

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.queries.spans.Spans
org.apache.lucene.queries.spans.ConjunctionSpans
Direct Known Subclasses:
ContainSpans, NearSpansOrdered, NearSpansUnordered
abstract class ConjunctionSpans extends Spans
Common super class for multiple sub spans required in a document.

  • Field Details

    • subSpans

      final Spans[] subSpans

    • conjunction

      final DocIdSetIterator conjunction

    • atFirstInCurrentDoc

      boolean atFirstInCurrentDoc

    • oneExhaustedInCurrentDoc

      boolean oneExhaustedInCurrentDoc

  • Constructor Details

    • ConjunctionSpans

      ConjunctionSpans(List<Spans> subSpans)

  • Method Details

    • docID

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

    • cost

      public 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

    • nextDoc

      public 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 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

    • toMatchDoc

      int toMatchDoc() throws IOException
      Throws:
      IOException

    • twoPhaseCurrentDocMatches

      abstract boolean twoPhaseCurrentDocMatches() throws IOException
      Throws:
      IOException

    • asTwoPhaseIterator

      public TwoPhaseIterator asTwoPhaseIterator()
      Return a TwoPhaseIterator view of this ConjunctionSpans.
      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

    • getSubSpans

      public Spans[] getSubSpans()

    • intersectSpans

      private static DocIdSetIterator intersectSpans(List<Spans> spanList)

    • addSpans

      private static void addSpans(Spans spans, List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)