Save This Page
Home » lucene-2.4.1-src » org.apache » lucene » search » [javadoc | source]
org.apache.lucene.search
abstract public class: SortComparator [javadoc | source]
java.lang.Object
   org.apache.lucene.search.SortComparator

All Implemented Interfaces:
    SortComparatorSource

Abstract base class for sorting hits returned by a Query.

This class should only be used if the other SortField types (SCORE, DOC, STRING, INT, FLOAT) do not provide an adequate sorting. It maintains an internal cache of values which could be quite large. The cache is an array of Comparable, one for each document in the index. There is a distinct Comparable for each unique term in the field - if some documents have the same term in the field, the cache array will have entries which reference the same Comparable.

Created: Apr 21, 2004 5:08:38 PM

Method from org.apache.lucene.search.SortComparator Summary:
getComparable,   newComparator
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.SortComparator Detail:
 abstract protected Comparable getComparable(String termtext)
    Returns an object which, when sorted according to natural order, will order the Term values in the correct order.

    For example, if the Terms contained integer values, this method would return new Integer(termtext). Note that this might not always be the most efficient implementation - for this particular example, a better implementation might be to make a ScoreDocLookupComparator that uses an internal lookup table of int.

 public ScoreDocComparator newComparator(IndexReader reader,
    String fieldname) throws IOException