org.apache.lucene.search

Class FakeScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.FakeScorer

final class FakeScorer
extends Scorer

Used by BulkScorers that need to pass a Scorer to LeafCollector.setScorer(org.apache.lucene.search.Scorer).

Nested Class Summary

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

Scorer.ChildScorer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	doc
(package private) int	freq
(package private) float	score

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

weight

Constructor Summary

Constructors

Constructor and Description
FakeScorer()

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
int	freq() Returns the freq of this Scorer on the current document
java.util.Collection<Scorer.ChildScorer>	getChildren() Returns child sub-scorers
Weight	getWeight() returns parent Weight
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

twoPhaseIterator

Methods inherited from class java.lang.Object

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

Field Detail

score

float score

doc

int doc

freq

int freq

Constructor Detail

FakeScorer

public FakeScorer()

Method Detail

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()

freq

public int freq()

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

score

public float score()

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

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

getWeight

public Weight getWeight()

Description copied from class: Scorer

returns parent Weight

Overrides:

getWeight in class Scorer

getChildren

public java.util.Collection<Scorer.ChildScorer> getChildren()

Description copied from class: Scorer

Returns child sub-scorers

Overrides:

getChildren in class Scorer