org.apache.lucene.search
public interface ScoreDocComparator
Created: Feb 3, 2004 9:00:16 AM
Since: lucene 1.4
Version: $Id: ScoreDocComparator.java 150348 2004-05-19 23:05:27Z tjones $
Field Summary | |
---|---|
static ScoreDocComparator | INDEXORDER Special comparator for sorting hits according to index order (document number). |
static ScoreDocComparator | RELEVANCE Special comparator for sorting hits according to computed relevance (document score). |
Method Summary | |
---|---|
int | compare(ScoreDoc i, ScoreDoc j)
Compares two ScoreDoc objects and returns a result indicating their
sort order. |
int | sortType()
Returns the type of sort. |
Comparable | sortValue(ScoreDoc i)
Returns the value used to sort the given document. |
Parameters: i First ScoreDoc j Second ScoreDoc
Returns: -1
if i
should come before j
1
if i
should come after j
0
if they are equal
See Also: java.util.Comparator
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.Returns: One of the constants in SortField.
See Also: SortField
Parameters: i Document
Returns: Serializable object
See Also: FieldDoc