FileDocCategorySizeDatePackage
ScoreDocComparator.javaAPI DocApache Lucene 2.2.03321Sat Jun 16 22:20:34 BST 2007org.apache.lucene.search

ScoreDocComparator

public interface ScoreDocComparator
Expert: Compares two ScoreDoc objects for sorting.

Created: Feb 3, 2004 9:00:16 AM

author
Tim Jones (Nacimiento Software)
since
lucene 1.4
version
$Id: ScoreDocComparator.java 518518 2007-03-15 08:48:00Z buschmi $

Fields Summary
static final ScoreDocComparator
RELEVANCE
Special comparator for sorting hits according to computed relevance (document score).
static final ScoreDocComparator
INDEXORDER
Special comparator for sorting hits according to index order (document number).
Constructors Summary
Methods Summary
public intcompare(org.apache.lucene.search.ScoreDoc i, org.apache.lucene.search.ScoreDoc j)
Compares two ScoreDoc objects and returns a result indicating their sort order.

param
i First ScoreDoc
param
j Second ScoreDoc
return
a negative integer if i should come before j
a positive integer if i should come after j
0 if they are equal
see
java.util.Comparator

public intsortType()
Returns the type of sort. Should return SortField.SCORE, SortField.DOC, SortField.STRING, SortField.INTEGER, SortField.FLOAT or SortField.CUSTOM. It is not valid to return SortField.AUTO. This is used by multisearchers to determine how to collate results from their searchers.

return
One of the constants in SortField.
see
SortField

public java.lang.ComparablesortValue(org.apache.lucene.search.ScoreDoc i)
Returns the value used to sort the given document. The object returned must implement the java.io.Serializable interface. This is used by multisearchers to determine how to collate results from their searchers.

see
FieldDoc
param
i Document
return
Serializable object