SortField
Stores information about how to sort documents by terms in an individual field. Fields must be indexed in order to sort by them.
Sorting on a numeric field that is indexed with both doc values and points may use an optimization to skip non-competitive documents. This optimization relies on the assumption that the same data is stored in these points and doc values.
Sorting on a SORTED(_SET) field that is indexed with both doc values and term index may use an optimization to skip non-competitive documents. This optimization relies on the assumption that the same data is stored in these term index and doc values.
Created: Feb 11, 2004 1:25:29 PM
Since
lucene 1.4
See also
Inheritors
Constructors
Creates a sort by terms in the given field with the type of term values explicitly given.
Creates a sort, possibly in reverse, by terms in the given field with the type of term values explicitly given.
Creates a sort with a custom comparison function.
Creates a sort, possibly in reverse, with a custom comparison function.
Types
Properties
Returns an IndexSorter used for sorting index segments by this SortField.
Return the value to use for documents that don't have a value. A value of null indicates that default should be used.
Returns whether sort optimization should be optimized with indexed data
Functions
Returns true if o is equal to this. If a FieldComparatorSource was provided, it must properly implement equals (unless a singleton is always used).
Returns the FieldComparator to use for sorting.
Returns the FieldComparatorSource used for custom sorting
Returns a hash code for this SortField instance. If a FieldComparatorSource was provided, it must properly implement hashCode (unless a singleton is always used).
Whether the relevance score is needed to sort documents.