Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Search.Spans.SpanScorer Class Reference

Public for extension only. More...

Inherits Lucene.Net.Search.Scorer.

Public Member Functions

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 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:
 
virtual bool SetFreqCurrentDoc ()
 
override int DocID ()
 Returns the following:


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

Public for extension only.

Definition at line 28 of file SpanScorer.cs.

Member Function Documentation

override int Lucene.Net.Search.Spans.SpanScorer.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.

<since>2.9</since>

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 66 of file SpanScorer.cs.

override int Lucene.Net.Search.Spans.SpanScorer.DocID ( )
virtual

Returns the following:

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 102 of file SpanScorer.cs.

override int Lucene.Net.Search.Spans.SpanScorer.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 57 of file SpanScorer.cs.

override float Lucene.Net.Search.Spans.SpanScorer.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 107 of file SpanScorer.cs.

virtual bool Lucene.Net.Search.Spans.SpanScorer.SetFreqCurrentDoc ( )
virtual

Definition at line 84 of file SpanScorer.cs.


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