org.apache.lucene.search

Interface ScoreDocComparator

public interface ScoreDocComparator

Expert: Compares two ScoreDoc objects for sorting.

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

Version:
$Id: ScoreDocComparator.java 150348 2004-05-19 23:05:27Z tjones $
Author:
Tim Jones (Nacimiento Software)
Since:
lucene 1.4

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.

Field Details

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

Method Details

compare

public int compare(ScoreDoc i,
                   ScoreDoc j)
Compares two ScoreDoc objects and returns a result indicating their sort order.
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:
Comparator

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.
Returns:
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.
Parameters:
i - Document
Returns:
Serializable object
See Also:
FieldDoc

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.