org.apache.lucene.queries.function

Class FunctionQuery.AllScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.queries.function.FunctionQuery.AllScorer

Enclosing class:

FunctionQuery

protected class FunctionQuery.AllScorer
extends Scorer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer

Scorer.ChildScorer

Constructor Summary

Constructors

Constructor and Description
AllScorer(LeafReaderContext context, FunctionQuery.FunctionWeight w, float boost)

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
Explanation	explain(int doc)
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
float	score() Returns the score of the current document matching the query.

Methods inherited from class org.apache.lucene.search.Scorer

getChildren, getWeight, twoPhaseIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllScorer

public AllScorer(LeafReaderContext context,
                 FunctionQuery.FunctionWeight w,
                 float boost)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

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.

Specified by:

iterator in class Scorer

docID

public int docID()

Description copied from class: Scorer

Returns the doc ID that is currently being scored. This will return -1 if the Scorer.iterator() is not positioned or DocIdSetIterator.NO_MORE_DOCS if it has been entirely consumed.

Specified by:

docID in class Scorer

See Also:

DocIdSetIterator.docID()

score

public float score()
            throws java.io.IOException

Description copied from class: Scorer

Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) is called on the Scorer.iterator() the first time, or when called from within LeafCollector.collect(int).

Specified by:

score in class Scorer

Throws:

java.io.IOException

explain

public Explanation explain(int doc)
                    throws java.io.IOException

Throws:

java.io.IOException