Module org.apache.lucene.queries

Package org.apache.lucene.queries.function

Class FunctionQuery.AllScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

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

Enclosing class:

FunctionQuery

protected class FunctionQuery.AllScorer
extends Scorer

Scores all documents, applying the function to each document

Nested Class Summary

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

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final float	boost
(package private) final DocIdSetIterator	iterator
(package private) final int	maxDoc
(package private) final IndexReader	reader
(package private) final FunctionValues	vals
(package private) final FunctionQuery.FunctionWeight	weight

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	docID()	Returns the doc ID that is currently being scored.
Explanation	explain(int doc)
float	getMaxScore(int upTo)	Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.
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

advanceShallow, getWeight, twoPhaseIterator

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

getChildren, setMinCompetitiveScore, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

reader

final IndexReader reader

weight

final FunctionQuery.FunctionWeight weight

maxDoc

final int maxDoc

boost

final float boost

iterator

final DocIdSetIterator iterator

vals

final FunctionValues vals

Constructor Details

AllScorer

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

Throws:

IOException

Method Details

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: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

Throws:

IOException

getMaxScore

public float getMaxScore(int upTo)
                  throws IOException

Description copied from class: Scorer

Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.

Specified by:

getMaxScore in class Scorer

Throws:

IOException

explain

public Explanation explain(int doc)
                    throws IOException

Throws:

IOException