Constructor SortField

SortField(String, SortFieldType)

Creates a sort by terms in the given field with the type of term values explicitly given.

Declaration
public SortField(string field, SortFieldType type)
Parameters
Type Name Description
System.String field

Name of field to sort by. Can be null if type is SCORE or DOC.

SortFieldType type

Type of values in the terms.

SortField(String, SortFieldType, Boolean)

Creates a sort, possibly in reverse, by terms in the given field with the type of term values explicitly given.

Declaration
public SortField(string field, SortFieldType type, bool reverse)
Parameters
Type Name Description
System.String field

Name of field to sort by. Can be null if type is SCORE or DOC.

SortFieldType type

Type of values in the terms.

System.Boolean reverse

True if natural order should be reversed.

SortField(String, FieldCache.IParser)

Creates a sort by terms in the given field, parsed to numeric values using a custom FieldCache.IParser.

Declaration
public SortField(string field, FieldCache.IParser parser)
Parameters
Type Name Description
System.String field

Name of field to sort by. Must not be null.

FieldCache.IParser parser

Instance of a FieldCache.IParser, which must subclass one of the existing numeric parsers from IFieldCache. Sort type is inferred by testing which numeric parser the parser subclasses.

SortField(String, FieldCache.IParser, Boolean)

Creates a sort, possibly in reverse, by terms in the given field, parsed to numeric values using a custom FieldCache.IParser.

Declaration
public SortField(string field, FieldCache.IParser parser, bool reverse)
Parameters
Type Name Description
System.String field

Name of field to sort by. Must not be null.

FieldCache.IParser parser

Instance of a FieldCache.IParser, which must subclass one of the existing numeric parsers from IFieldCache. Sort type is inferred by testing which numeric parser the parser subclasses.

System.Boolean reverse

True if natural order should be reversed.

SortField(String, FieldComparerSource)

Creates a sort with a custom comparison function.

Declaration
public SortField(string field, FieldComparerSource comparer)
Parameters
Type Name Description
System.String field

Name of field to sort by; cannot be null.

FieldComparerSource comparer

Returns a comparer for sorting hits.

SortField(String, FieldComparerSource, Boolean)

Creates a sort, possibly in reverse, with a custom comparison function.

Declaration
public SortField(string field, FieldComparerSource comparer, bool reverse)
Parameters
Type Name Description
System.String field

Name of field to sort by; cannot be null.

FieldComparerSource comparer

Returns a comparer for sorting hits.

System.Boolean reverse

True if natural order should be reversed.