Package org.apache.lucene.search
Class FilterScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.FilterScorer
-
- All Implemented Interfaces:
Unwrappable<Scorer>
public abstract class FilterScorer extends Scorer implements Unwrappable<Scorer>
AFilterScorercontains anotherScorer, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The classFilterScoreritself simply implements all abstract methods ofScorerwith versions that pass all requests to the contained scorer. Subclasses ofFilterScorermay further override some of these methods and may also provide additional methods and fields.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Constructor Summary
Constructors Constructor Description FilterScorer(Scorer in)Create a new FilterScorerFilterScorer(Scorer in, Weight weight)Create a new FilterScorer with a specific weight
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdocID()Returns the doc ID that is currently being scored.DocIdSetIteratoriterator()Return aDocIdSetIteratorover matching documents.floatscore()Returns the score of the current document matching the query.TwoPhaseIteratortwoPhaseIterator()Optional method: Return aTwoPhaseIteratorview of thisScorer.Scorerunwrap()Unwraps this instance-
Methods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getMaxScore, getWeight
-
Methods inherited from class org.apache.lucene.search.Scorable
getChildren, setMinCompetitiveScore, smoothingScore
-
-
-
-
Field Detail
-
in
protected final Scorer in
-
-
Method Detail
-
score
public float score() throws IOExceptionDescription copied from class:ScorableReturns the score of the current document matching the query.- Specified by:
scorein classScorable- Throws:
IOException
-
docID
public final int docID()
Description copied from class:ScorableReturns the doc ID that is currently being scored.
-
iterator
public final DocIdSetIterator iterator()
Description copied from class:ScorerReturn aDocIdSetIteratorover matching documents.The returned iterator will either be positioned on
-1if no documents have been scored yet,DocIdSetIterator.NO_MORE_DOCSif 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 final TwoPhaseIterator twoPhaseIterator()
Description copied from class:ScorerOptional method: Return aTwoPhaseIteratorview of thisScorer. A return value ofnullindicates that two-phase iteration is not supported.Note that the returned
TwoPhaseIterator'sapproximationmust advance synchronously with theScorer.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.- Overrides:
twoPhaseIteratorin classScorer
-
unwrap
public Scorer unwrap()
Description copied from interface:UnwrappableUnwraps this instance- Specified by:
unwrapin interfaceUnwrappable<Scorer>
-
-