Inherits Lucene.Net.Search.Scorer.

Classes
class	Bucket

class	BucketTable
	A simple hash table of document scores within a range.

class	SubScorer

Public Member Functions
	BooleanScorer (Similarity similarity, int minNrShouldMatch, System.Collections.Generic.List< Scorer > optionalScorers, System.Collections.Generic.List< Scorer > prohibitedScorers)

override 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.

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:

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 void	Score (Collector collector)
	Scores and collects all matching documents.

override System.String	ToString ()

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

Definition at line 58 of file BooleanScorer.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.BooleanScorer.BooleanScorer	(	Similarity	similarity,
		int	minNrShouldMatch,
		System.Collections.Generic.List< Scorer >	optionalScorers,
		System.Collections.Generic.List< Scorer >	prohibitedScorers
	)

Definition at line 227 of file BooleanScorer.cs.

Member Function Documentation

override int Lucene.Net.Search.BooleanScorer.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 333 of file BooleanScorer.cs.

override int Lucene.Net.Search.BooleanScorer.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 338 of file BooleanScorer.cs.

override int Lucene.Net.Search.BooleanScorer.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 343 of file BooleanScorer.cs.

override bool Lucene.Net.Search.BooleanScorer.Score	(	Collector	collector,
		int	max,
		int	firstDocID
	)

virtual

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

Parameters

collector	The collector to which all matching documents are passed.
max	Do not score documents past this.
firstDocID	The first document ID (ensures DocIdSetIterator.NextDoc() is called before this method.

Returns: true if more matching documents may remain.

Reimplemented from Lucene.Net.Search.Scorer.

Definition at line 269 of file BooleanScorer.cs.

override float Lucene.Net.Search.BooleanScorer.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 382 of file BooleanScorer.cs.

override void Lucene.Net.Search.BooleanScorer.Score ( Collector collector )

virtual

Scores and collects all matching documents.

Parameters

collector The collector to which all matching documents are passed.

Reimplemented from Lucene.Net.Search.Scorer.

Definition at line 387 of file BooleanScorer.cs.

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

Definition at line 392 of file BooleanScorer.cs.

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