Lucene.Net.Search.FieldComparator.DocComparator Class Reference

Sorts by ascending docID More...

Inherits Lucene.Net.Search.FieldComparator.

Public Member Functions
override int	Compare (int slot1, int slot2)
	Compare hit at slot1 with hit at slot2.
override int	CompareBottom (int doc)
	Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as Compare(int,int) } as if bottom were slot1 and the new document were slot 2.
override void	Copy (int slot, int doc)
	This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.
override void	SetNextReader (IndexReader reader, int docBase)
	Set a new Reader. All doc correspond to the current Reader.
override void	SetBottom (int bottom)
	Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When CompareBottom is called, you should compare against this slot. This will always be called before CompareBottom.
Public Member Functions inherited from Lucene.Net.Search.FieldComparator
virtual void	SetScorer (Scorer scorer)
	Sets the Scorer to use in case a document's score is needed.

Properties
override IComparable	this[int slot] [get]
Properties inherited from Lucene.Net.Search.FieldComparator
abstract IComparable	this[int slot] [get]
	Return the actual value in the slot.

Detailed Description

Sorts by ascending docID

Definition at line 223 of file FieldComparator.cs.

Member Function Documentation

override int Lucene.Net.Search.FieldComparator.DocComparator.Compare ( int  slot1, int  slot2  )

virtual

Compare hit at slot1 with hit at slot2.

Parameters

slot1	first slot to compare
slot2	second slot to compare

Returns

any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal

Implements Lucene.Net.Search.FieldComparator.

Definition at line 234 of file FieldComparator.cs.

override int Lucene.Net.Search.FieldComparator.DocComparator.CompareBottom ( int  doc )

virtual

Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as Compare(int,int) } as if bottom were slot1 and the new document were slot 2.

For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).

Parameters

doc	that was hit

Returns

any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.

Implements Lucene.Net.Search.FieldComparator.

Definition at line 240 of file FieldComparator.cs.

override void Lucene.Net.Search.FieldComparator.DocComparator.Copy ( int  slot, int  doc  )

virtual

This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.

Parameters

slot	which slot to copy the hit to
doc	docID relative to current reader

Implements Lucene.Net.Search.FieldComparator.

Definition at line 246 of file FieldComparator.cs.

override void Lucene.Net.Search.FieldComparator.DocComparator.SetBottom ( int  slot )

virtual

Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When CompareBottom is called, you should compare against this slot. This will always be called before CompareBottom.

Parameters

slot	the currently weakest (sorted last) slot in the queue

Implements Lucene.Net.Search.FieldComparator.

Definition at line 259 of file FieldComparator.cs.

override void Lucene.Net.Search.FieldComparator.DocComparator.SetNextReader ( IndexReader  reader, int  docBase  )

virtual

Set a new Reader. All doc correspond to the current Reader.

Parameters

reader	current reader
docBase	docBase of this reader

<throws> IOException </throws> <throws> IOException </throws>

Implements Lucene.Net.Search.FieldComparator.

Definition at line 251 of file FieldComparator.cs.

Property Documentation

override IComparable Lucene.Net.Search.FieldComparator.DocComparator.this[int slot]

get

Definition at line 265 of file FieldComparator.cs.

---

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

• core/Search/FieldComparator.cs