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) final float	boost
(package private) final LeafSimScorer	docScorer
(package private) final TermScorer	in

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

weight

Constructor Summary

Constructors

Constructor	Description
FreqBoostTermScorer(float boost, TermScorer in, LeafSimScorer docScorer)

Method Summary

Modifier and Type	Method	Description
int	advanceShallow(int target)	Advance to the block of documents that contains target 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 last target that this iterator was shallow-advanced to included and upTo 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 given minScore.

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

docID, iterator, twoPhaseIterator, unwrap

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

getWeight

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

getChildren, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

boost

final float boost

in

final TermScorer in

docScorer

final LeafSimScorer docScorer

Constructor Details

FreqBoostTermScorer

public FreqBoostTermScorer(float boost,
 TermScorer in,
 LeafSimScorer docScorer)

Method Details

freq

float freq()
    throws IOException

Throws:

IOException

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Overrides:

score in class FilterScorer

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

advanceShallow

public int advanceShallow(int target)
                   throws IOException

Description copied from class: Scorer

Advance to the block of documents that contains target in order to get scoring information about this block. This method is implicitly called by DocIdSetIterator.advance(int) and DocIdSetIterator.nextDoc() on the returned doc ID. Calling this method doesn't modify the current DocIdSetIterator.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 to Scorer.advanceShallow(int) so far.

Overrides:

advanceShallow in class Scorer

Throws:

IOException

setMinCompetitiveScore

public void setMinCompetitiveScore(float minScore)
                            throws 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 given minScore. 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 of minScore.

Overrides:

setMinCompetitiveScore in class Scorable

Throws:

IOException