Class TotalHitCountCollector

Just counts the total number of hits.

Inheritance

object

TotalHitCountCollector

Implements

ICollector

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search

Assembly: Lucene.Net.dll

Syntax

public class TotalHitCountCollector : ICollector

Properties

AcceptsDocsOutOfOrder

Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to Collect(int).

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

Declaration

public virtual bool AcceptsDocsOutOfOrder { get; }

Property Value

Type	Description
bool

TotalHits

Returns how many hits matched the search.

Declaration

public virtual int TotalHits { get; }

Property Value

Type	Description
int

Methods

Collect(int)

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

Note: The collection of the current segment can be terminated by throwing a CollectionTerminatedException. In this case, the last docs of the current AtomicReaderContext will be skipped and IndexSearcher will swallow the exception and continue collection with the next leaf.

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

Declaration

public virtual void Collect(int doc)

Parameters

Type	Name	Description
int	doc

SetNextReader(AtomicReaderContext)

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

Add DocBase to the current Reader's internal document id to re-base ids in Collect(int).

Declaration

public virtual void SetNextReader(AtomicReaderContext context)

Parameters

Type	Name	Description
AtomicReaderContext	context	next atomic reader context

SetScorer(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.GetScore() when needed.

Declaration

public virtual void SetScorer(Scorer scorer)

Parameters

Type	Name	Description
Scorer	scorer

Implements

ICollector