Expert: Scoring functionality for phrase queries.
A document is considered matching if it contains the phrase-query terms at "valid" positons. What "valid positions" are depends on the type of the phrase query: for an exact phrase query terms are required to appear in adjacent locations, while for a sloppy phrase query some distance between the terms is allowed. The abstract method PhraseFreq() of extending classes is invoked for each document containing all the phrase query terms, in order to compute the frequency of the phrase query in that document. A non zero frequency means a match. More...

Inherits Lucene.Net.Search.Scorer.

Inherited by Lucene.Net.Search.ExactPhraseScorer, and Lucene.Net.Search.SloppyPhraseScorer.

Public Member Functions
override int	DocID ()
	Returns the following: -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet. NO_MORE_DOCS if the iterator has exhausted. Otherwise it should return the doc ID it is currently on.

override int	NextDoc ()
	Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

override float	Score ()
	Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.NextDoc() or DocIdSetIterator.Advance(int) is called the first time, or when called from within Collector.Collect(int).

override int	Advance (int target)
	Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set. Behaves as if written:

float	CurrentFreq ()
	Phrase frequency in current doc as computed by PhraseFreq()

override System.String	ToString ()

Public Member Functions inherited from Lucene.Net.Search.Scorer
virtual void	Score (Collector collector)
	Scores and collects all matching documents.

virtual bool	Score (Collector collector, int max, int firstDocID)
	Expert: Collects matching documents in a range. Hook for optimization. Note, firstDocID is added to ensure that DocIdSetIterator.NextDoc() was called before this method.

Additional Inherited Members
Static Public Attributes inherited from Lucene.Net.Search.DocIdSetIterator
static readonly int	NO_MORE_DOCS = System.Int32.MaxValue
	When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator.

Properties inherited from Lucene.Net.Search.Scorer
virtual Similarity	Similarity `[get]`
	Returns the Similarity implementation used by this scorer.

Detailed Description

Expert: Scoring functionality for phrase queries.
A document is considered matching if it contains the phrase-query terms at "valid" positons. What "valid positions" are depends on the type of the phrase query: for an exact phrase query terms are required to appear in adjacent locations, while for a sloppy phrase query some distance between the terms is allowed. The abstract method PhraseFreq() of extending classes is invoked for each document containing all the phrase query terms, in order to compute the frequency of the phrase query in that document. A non zero frequency means a match.

Definition at line 35 of file PhraseScorer.cs.

Member Function Documentation

override int Lucene.Net.Search.PhraseScorer.Advance ( int target )

virtual

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set. Behaves as if written:

int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }

Some implementations are considerably more efficient than that.

NOTE: certain implemenations may return a different value (each time) if called several times in a row with the same target.

NOTE: this method may be called with NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 135 of file PhraseScorer.cs.

float Lucene.Net.Search.PhraseScorer.CurrentFreq ( )

Phrase frequency in current doc as computed by PhraseFreq()

Returns

Definition at line 157 of file PhraseScorer.cs.

override int Lucene.Net.Search.PhraseScorer.DocID ( )

virtual

Returns the following:

-1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet.
NO_MORE_DOCS if the iterator has exhausted.
Otherwise it should return the doc ID it is currently on.

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 78 of file PhraseScorer.cs.

override int Lucene.Net.Search.PhraseScorer.NextDoc ( )

virtual

Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 83 of file PhraseScorer.cs.

override float Lucene.Net.Search.PhraseScorer.Score ( )

virtual

Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.NextDoc() or DocIdSetIterator.Advance(int) is called the first time, or when called from within Collector.Collect(int).

Implements Lucene.Net.Search.Scorer.

Definition at line 128 of file PhraseScorer.cs.

override System.String Lucene.Net.Search.PhraseScorer.ToString ( )

Definition at line 219 of file PhraseScorer.cs.

The documentation for this class was generated from the following file:

core/Search/PhraseScorer.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation