org.apache.lucene.search

Class ExactPhraseScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.ExactPhraseScorer

final class ExactPhraseScorer
extends Scorer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ExactPhraseScorer.PostingsAndPosition

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer

Scorer.ChildScorer

Field Summary

Fields

Modifier and Type	Field and Description
private ConjunctionDISI	conjunction
private Similarity.SimScorer	docScorer
private int	freq
private float	matchCost
private boolean	needsScores
private ExactPhraseScorer.PostingsAndPosition[]	postings

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

weight

Constructor Summary

Constructors

Constructor and Description
ExactPhraseScorer(Weight weight, PhraseQuery.PostingsAndFreq[] postings, Similarity.SimScorer docScorer, boolean needsScores, float matchCost)

Method Summary

Modifier and Type	Method and Description
private static boolean	advancePosition(ExactPhraseScorer.PostingsAndPosition posting, int target) Advance the given pos enum to the first doc on or after target.
int	docID() Returns the doc ID that is currently being scored.
int	freq() Returns the freq of this Scorer on the current document
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
private int	phraseFreq()
float	score() Returns the score of the current document matching the query.
java.lang.String	toString()
TwoPhaseIterator	twoPhaseIterator() Optional method: Return a TwoPhaseIterator view of this Scorer.

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

getChildren, getWeight

Methods inherited from class java.lang.Object

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

Field Detail

conjunction

private final ConjunctionDISI conjunction

postings

private final ExactPhraseScorer.PostingsAndPosition[] postings

freq

private int freq

docScorer

private final Similarity.SimScorer docScorer

needsScores

private final boolean needsScores

matchCost

private float matchCost

Constructor Detail

ExactPhraseScorer

ExactPhraseScorer(Weight weight,
                  PhraseQuery.PostingsAndFreq[] postings,
                  Similarity.SimScorer docScorer,
                  boolean needsScores,
                  float matchCost)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

twoPhaseIterator

public TwoPhaseIterator twoPhaseIterator()

Description copied from class: Scorer

Optional method: Return a TwoPhaseIterator view of this Scorer. A return value of null indicates that two-phase iteration is not supported. Note that the returned TwoPhaseIterator's approximation must advance synchronously with the Scorer.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:

twoPhaseIterator in class Scorer

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

Return a DocIdSetIterator 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.

Specified by:

iterator in class Scorer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

freq

public int freq()

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

docID

public int docID()

Description copied from class: Scorer

Returns the doc ID that is currently being scored. This will return -1 if the Scorer.iterator() is not positioned or DocIdSetIterator.NO_MORE_DOCS if it has been entirely consumed.

Specified by:

docID in class Scorer

See Also:

DocIdSetIterator.docID()

score

public float score()

Description copied from class: Scorer

Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) is called on the Scorer.iterator() the first time, or when called from within LeafCollector.collect(int).

Specified by:

score in class Scorer

advancePosition

private static boolean advancePosition(ExactPhraseScorer.PostingsAndPosition posting,
                                       int target)
                                throws java.io.IOException

Advance the given pos enum to the first doc on or after target. Return false if the enum was exhausted before reaching target and true otherwise.

Throws:

java.io.IOException

phraseFreq

private int phraseFreq()
                throws java.io.IOException

Throws:

java.io.IOException