Apache Lucene.Net 2.4.0 Class Library API

SortField Members

SortField overview

Public Static Fields

AUTOGuess type of sort based on field contents. A regular expression is used to look at the first term indexed for the field and determine if it represents an integer number, a floating point number, or just arbitrary string characters.
BYTE Sort using term values as encoded bytes. Sort values are bytes and lower values are at the front.
CUSTOMSort using a custom Comparator. Sort values are any Comparable and sorting is done according to natural order.
DOCSort by document number (index order). Sort values are Integer and lower values are at the front.
DOUBLESort using term values as encoded Doubles. Sort values are Double and lower values are at the front.
FIELD_DOCRepresents sorting by document number (index order).
FIELD_SCORERepresents sorting by document score (relevancy).
FLOATSort using term values as encoded Floats. Sort values are Float and lower values are at the front.
INTSort using term values as encoded Integers. Sort values are Integer and lower values are at the front.
LONGSort using term values as encoded Longs. Sort values are Long and lower values are at the front.
SCORESort by document score (relevancy). Sort values are Float and higher values are at the front.
SHORT Sort using term values as encoded shorts. Sort values are shorts and lower values are at the front.
STRINGSort using term values as Strings. Sort values are String and lower values are at the front.

Public Instance Constructors

SortField Overloaded. Initializes a new instance of the SortField class.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetFactory 
GetFieldReturns the name of the field. Could return
null
if the sort is by SCORE or DOC.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetLocaleReturns the Locale by which term values are interpreted. May return
null
if no Locale was specified.
GetReverseReturns whether the sort should be reversed.
GetTypeReturns the type of contents in the field.
ToString 

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

SortField Class | Lucene.Net.Search Namespace |