Class Scorer

    • Field Detail

      • weight

        protected final Weight weight
        the Scorer's parent Weight
    • Constructor Detail

      • Scorer

        protected Scorer​(Weight weight)
        Constructs a Scorer
        weight - The scorers Weight.
    • Method Detail

      • getWeight

        public Weight getWeight()
        returns parent Weight
        WARNING: This API is experimental and might change in incompatible ways in the next release.
      • iterator

        public abstract DocIdSetIterator iterator()
        Return a DocIdSetIterator over matching documents.

        The returned iterator will either be positioned on -1 if no documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS if all documents have been scored already, or the last document id that has been scored otherwise.

        The returned iterator is a view: calling this method several times will return iterators that have the same state.

      • twoPhaseIterator

        public TwoPhaseIterator twoPhaseIterator()
        Optional method: Return a TwoPhaseIterator view of this Scorer. A return value of null indicates that two-phase iteration is not supported.

        Note that the returned TwoPhaseIterator's approximation must advance synchronously with the iterator(): advancing the approximation must advance the iterator and vice-versa.

        Implementing this method is typically useful on Scorers that have a high per-document overhead in order to confirm matches.

        The default implementation returns null.

      • getMaxScore

        public abstract float getMaxScore​(int upTo)
                                   throws IOException
        Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.