Module org.apache.lucene.core
Package org.apache.lucene.search
Class SynonymQuery.FreqBoostTermScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.FilterScorer
-
- org.apache.lucene.search.SynonymQuery.FreqBoostTermScorer
-
- All Implemented Interfaces:
Unwrappable<Scorer>
- Enclosing class:
- SynonymQuery
private static class SynonymQuery.FreqBoostTermScorer extends FilterScorer
-
-
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) float
boost
(package private) LeafSimScorer
docScorer
(package private) TermScorer
in
-
Constructor Summary
Constructors Constructor Description FreqBoostTermScorer(float boost, TermScorer in, LeafSimScorer docScorer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
advanceShallow(int target)
Advance to the block of documents that containstarget
in order to get scoring information about this block.(package private) float
freq()
float
getMaxScore(int upTo)
Return the maximum score that documents between the lasttarget
that this iterator wasshallow-advanced
to included andupTo
included.float
score()
Returns the score of the current document matching the query.void
setMinCompetitiveScore(float minScore)
Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore
.-
Methods inherited from class org.apache.lucene.search.FilterScorer
docID, iterator, twoPhaseIterator, unwrap
-
Methods inherited from class org.apache.lucene.search.Scorable
getChildren, smoothingScore
-
-
-
-
Field Detail
-
boost
final float boost
-
in
final TermScorer in
-
docScorer
final LeafSimScorer docScorer
-
-
Constructor Detail
-
FreqBoostTermScorer
public FreqBoostTermScorer(float boost, TermScorer in, LeafSimScorer docScorer)
-
-
Method Detail
-
freq
float freq() throws java.io.IOException
- Throws:
java.io.IOException
-
score
public float score() throws java.io.IOException
Description copied from class:Scorable
Returns the score of the current document matching the query.- Overrides:
score
in classFilterScorer
- Throws:
java.io.IOException
-
getMaxScore
public float getMaxScore(int upTo) throws java.io.IOException
Description copied from class:Scorer
Return the maximum score that documents between the lasttarget
that this iterator wasshallow-advanced
to included andupTo
included.- Specified by:
getMaxScore
in classScorer
- Throws:
java.io.IOException
-
advanceShallow
public int advanceShallow(int target) throws java.io.IOException
Description copied from class:Scorer
Advance to the block of documents that containstarget
in order to get scoring information about this block. This method is implicitly called byDocIdSetIterator.advance(int)
andDocIdSetIterator.nextDoc()
on the returned doc ID. Calling this method doesn't modify the currentDocIdSetIterator.docID()
. It returns a number that is greater than or equal to all documents contained in the current block, but less than any doc IDS of the next block.target
must be >=Scorable.docID()
as well as all targets that have been passed toScorer.advanceShallow(int)
so far.- Overrides:
advanceShallow
in classScorer
- Throws:
java.io.IOException
-
setMinCompetitiveScore
public void setMinCompetitiveScore(float minScore) throws java.io.IOException
Description copied from class:Scorable
Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore
. This is a no-op by default.This method may only be called from collectors that use
ScoreMode.TOP_SCORES
, and successive calls may only set increasing values ofminScore
.- Overrides:
setMinCompetitiveScore
in classScorable
- Throws:
java.io.IOException
-
-