org.apache.lucene.search
public class SortField extends Object implements Serializable
Created: Feb 11, 2004 1:25:29 PM
Since: lucene 1.4
Version: $Id: SortField.java 150357 2004-05-24 22:51:42Z tjones $
See Also: Sort
Field Summary | |
---|---|
static int | AUTO Guess type of sort based on field contents. |
static int | CUSTOM Sort using a custom Comparator. |
static int | DOC Sort by document number (index order). |
static SortField | FIELD_DOC Represents sorting by document number (index order). |
static SortField | FIELD_SCORE Represents sorting by document score (relevancy). |
static int | FLOAT Sort using term values as encoded Floats. |
static int | INT Sort using term values as encoded Integers. |
static int | SCORE Sort by document score (relevancy). |
static int | STRING Sort using term values as Strings. |
Constructor Summary | |
---|---|
SortField(String field) Creates a sort by terms in the given field where the type of term value
is determined dynamically ( AUTO ). | |
SortField(String field, boolean reverse) Creates a sort, possibly in reverse, by terms in the given field where
the type of term value is determined dynamically ( AUTO ). | |
SortField(String field, int type) Creates a sort by terms in the given field with the type of term
values explicitly given. | |
SortField(String field, int type, boolean reverse) Creates a sort, possibly in reverse, by terms in the given field with the
type of term values explicitly given. | |
SortField(String field, Locale locale) Creates a sort by terms in the given field sorted
according to the given locale. | |
SortField(String field, Locale locale, boolean reverse) Creates a sort, possibly in reverse, by terms in the given field sorted
according to the given locale. | |
SortField(String field, SortComparatorSource comparator) Creates a sort with a custom comparison function. | |
SortField(String field, SortComparatorSource comparator, boolean reverse) Creates a sort, possibly in reverse, with a custom comparison function. |
Method Summary | |
---|---|
SortComparatorSource | getFactory() |
String | getField() Returns the name of the field. |
Locale | getLocale() Returns the Locale by which term values are interpreted.
|
boolean | getReverse() Returns whether the sort should be reversed. |
int | getType() Returns the type of contents in the field. |
String | toString() |
AUTO
).Parameters: field Name of field to sort by, cannot be null
.
AUTO
).Parameters: field Name of field to sort by, cannot be null
. reverse True if natural order should be reversed.
Parameters: field Name of field to sort by. Can be null
if
type
is SCORE or DOC. type Type of values in the terms.
Parameters: field Name of field to sort by. Can be null
if
type
is SCORE or DOC. type Type of values in the terms. reverse True if natural order should be reversed.
Parameters: field Name of field to sort by, cannot be null
. locale Locale of values in the field.
Parameters: field Name of field to sort by, cannot be null
. locale Locale of values in the field.
Parameters: field Name of field to sort by; cannot be null
. comparator Returns a comparator for sorting hits.
Parameters: field Name of field to sort by; cannot be null
. comparator Returns a comparator for sorting hits. reverse True if natural order should be reversed.
null
if the sort is by SCORE or DOC.Returns: Name of field, possibly null
.
null
if no Locale was specified.Returns: Locale, or null
.
Returns: True if natural order should be reversed.
Returns: One of the constants SCORE, DOC, AUTO, STRING, INT or FLOAT.