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 | Properties | List of all members
Lucene.Net.Search.PositiveScoresOnlyCollector Class Reference

A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected. More...

Inherits Lucene.Net.Search.Collector.

Public Member Functions

 PositiveScoresOnlyCollector (Collector c)
 
override void Collect (int doc)
 Called once for every document matching a query, with the unbased document number.
 
override void SetNextReader (IndexReader reader, int docBase)
 Called before collecting from each IndexReader. All doc ids in Collect(int) will correspond to reader.
 
override void SetScorer (Scorer scorer)
 Called before successive calls to Collect(int). Implementations that need the score of the current document (passed-in to Collect(int)), should save the passed-in Scorer and call scorer.score() when needed.
 

Properties

override bool AcceptsDocsOutOfOrder [get]
 
- Properties inherited from Lucene.Net.Search.Collector
abstract bool AcceptsDocsOutOfOrder [get]
 Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to Collect. Most Lucene Query implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of BooleanQuery) can achieve faster searching if the Collector allows them to deliver the docIDs out of order. Many collectors don't mind getting docIDs out of order, so it's important to return true here.
 

Detailed Description

A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected.

Definition at line 29 of file PositiveScoresOnlyCollector.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.PositiveScoresOnlyCollector.PositiveScoresOnlyCollector ( Collector  c)

Definition at line 35 of file PositiveScoresOnlyCollector.cs.

Member Function Documentation

override void Lucene.Net.Search.PositiveScoresOnlyCollector.Collect ( int  doc)
virtual

Called once for every document matching a query, with the unbased document number.

Note: This is called in an inner search loop. For good search performance, implementations of this method should not call Searcher.Doc(int) or Lucene.Net.Index.IndexReader.Document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Implements Lucene.Net.Search.Collector.

Definition at line 40 of file PositiveScoresOnlyCollector.cs.

override void Lucene.Net.Search.PositiveScoresOnlyCollector.SetNextReader ( IndexReader  reader,
int  docBase 
)
virtual

Called before collecting from each IndexReader. All doc ids in Collect(int) will correspond to reader.

Add docBase to the current IndexReaders internal document id to re-base ids in Collect(int).

Parameters
readernext IndexReader
docBase

Implements Lucene.Net.Search.Collector.

Definition at line 48 of file PositiveScoresOnlyCollector.cs.

override void Lucene.Net.Search.PositiveScoresOnlyCollector.SetScorer ( Scorer  scorer)
virtual

Called before successive calls to Collect(int). Implementations that need the score of the current document (passed-in to Collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Implements Lucene.Net.Search.Collector.

Definition at line 53 of file PositiveScoresOnlyCollector.cs.

Property Documentation

override bool Lucene.Net.Search.PositiveScoresOnlyCollector.AcceptsDocsOutOfOrder
get

Definition at line 62 of file PositiveScoresOnlyCollector.cs.


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