Package org.apache.lucene.search
Class TermScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.TermScorer
-
final class TermScorer extends Scorer
Expert: AScorer
for documents matching aTerm
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Field Summary
Fields Modifier and Type Field Description private LeafSimScorer
docScorer
private ImpactsDISI
impactsDisi
private ImpactsEnum
impactsEnum
private DocIdSetIterator
iterator
private PostingsEnum
postingsEnum
-
Constructor Summary
Constructors Constructor Description TermScorer(Weight weight, ImpactsEnum impactsEnum, LeafSimScorer docScorer)
Construct aTermScorer
that will use impacts to skip blocks of non-competitive documents.TermScorer(Weight weight, PostingsEnum postingsEnum, LeafSimScorer docScorer)
Construct aTermScorer
that will iterate all documents.
-
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.int
docID()
Returns the doc ID that is currently being scored.(package private) int
freq()
float
getMaxScore(int upTo)
Return the maximum score that documents between the lasttarget
that this iterator wasshallow-advanced
to included andupTo
included.DocIdSetIterator
iterator()
Return aDocIdSetIterator
over matching documents.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
.java.lang.String
toString()
Returns a string representation of thisTermScorer
.-
Methods inherited from class org.apache.lucene.search.Scorer
getWeight, twoPhaseIterator
-
Methods inherited from class org.apache.lucene.search.Scorable
getChildren
-
-
-
-
Field Detail
-
postingsEnum
private final PostingsEnum postingsEnum
-
impactsEnum
private final ImpactsEnum impactsEnum
-
iterator
private final DocIdSetIterator iterator
-
docScorer
private final LeafSimScorer docScorer
-
impactsDisi
private final ImpactsDISI impactsDisi
-
-
Constructor Detail
-
TermScorer
TermScorer(Weight weight, PostingsEnum postingsEnum, LeafSimScorer docScorer)
Construct aTermScorer
that will iterate all documents.
-
TermScorer
TermScorer(Weight weight, ImpactsEnum impactsEnum, LeafSimScorer docScorer)
Construct aTermScorer
that will use impacts to skip blocks of non-competitive documents.
-
-
Method Detail
-
docID
public int docID()
Description copied from class:Scorable
Returns the doc ID that is currently being scored.
-
freq
final int freq() throws java.io.IOException
- Throws:
java.io.IOException
-
iterator
public DocIdSetIterator iterator()
Description copied from class:Scorer
Return aDocIdSetIterator
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.
-
score
public float score() throws java.io.IOException
Description copied from class:Scorable
Returns the score of the current document matching the query.
-
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
-
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
-
setMinCompetitiveScore
public void setMinCompetitiveScore(float minScore)
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 useScoreMode.TOP_SCORES
, and successive calls may only set increasing values ofminScore
.- Overrides:
setMinCompetitiveScore
in classScorable
-
toString
public java.lang.String toString()
Returns a string representation of thisTermScorer
.- Overrides:
toString
in classjava.lang.Object
-
-