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>
A
FilterScorer contains another Scorer, which it uses as its basic source of
data, possibly transforming the data along the way or providing additional functionality. The
class FilterScorer itself simply implements all abstract methods of Scorer with
versions that pass all requests to the contained scorer. Subclasses of FilterScorer may
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 -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal intdocID()Returns the doc ID that is currently being scored.final DocIdSetIteratoriterator()Return aDocIdSetIteratorover matching documents.floatscore()Returns the score of the current document matching the query.final TwoPhaseIteratorOptional method: Return aTwoPhaseIteratorview of thisScorer.unwrap()Unwraps this instanceMethods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getMaxScoreMethods inherited from class org.apache.lucene.search.Scorable
getChildren, setMinCompetitiveScore, smoothingScore
-
Field Details
-
in
-
-
Constructor Details
-
FilterScorer
Create a new FilterScorer with a specific weight- Parameters:
in- theScorerto wrap
-
-
Method Details
-
score
Description 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:ScorerReturns the doc ID that is currently being scored. -
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
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
Description copied from interface:UnwrappableUnwraps this instance- Specified by:
unwrapin interfaceUnwrappable<Scorer>
-