org.apache.lucene.search
Interface ScoreDocComparator
public interface ScoreDocComparator
Expert: Compares two ScoreDoc objects for sorting.
Created: Feb 3, 2004 9:00:16 AM
$Id: ScoreDocComparator.java 150348 2004-05-19 23:05:27Z tjones $- Tim Jones (Nacimiento Software)
INDEXORDER
public static final ScoreDocComparator INDEXORDER
Special comparator for sorting hits according to index order (document number).
RELEVANCE
public static final ScoreDocComparator RELEVANCE
Special comparator for sorting hits according to computed relevance (document score).
compare
public int compare(ScoreDoc i,
ScoreDoc j)
Compares two ScoreDoc objects and returns a result indicating their
sort order.
i
- First ScoreDocj
- Second ScoreDoc
-1
if i
should come before j
1
if i
should come after j
0
if they are equal
sortType
public int sortType()
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.
- One of the constants in SortField.
sortValue
public Comparable sortValue(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.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.