Uses of Class
org.apache.lucene.search.SortField

Packages that use SortField

Package	Description
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.expressions	Expressions.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.queries.function	Queries that compute score based upon a function.
org.apache.lucene.queries.function.valuesource	A variety of functions to use with FunctionQuery.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.join	Support for index-time and query-time joins.

Uses of SortField in org.apache.lucene.document

Subclasses of SortField in org.apache.lucene.document

Modifier and Type	Class	Description
(package private) final class	FeatureSortField	Sorts using the value of a specified feature name from a FeatureField.
(package private) final class	LatLonPointSortField	Sorts by distance from an origin location.
(package private) final class	XYPointSortField	Sorts by distance from an origin location.

Methods in org.apache.lucene.document that return SortField

Modifier and Type	Method	Description
static SortField	LatLonDocValuesField.newDistanceSort(String field, double latitude, double longitude)	Creates a SortField for sorting by distance from a location.
static SortField	XYDocValuesField.newDistanceSort(String field, float x, float y)	Creates a SortField for sorting by distance from a location.
static SortField	FeatureField.newFeatureSort(String field, String featureName)	Creates a SortField for sorting by the value of a feature.

Uses of SortField in org.apache.lucene.expressions

Methods in org.apache.lucene.expressions that return SortField

Modifier and Type	Method	Description
SortField	Expression.getSortField(Bindings bindings, boolean reverse)	Get a sort field which can be used to rank documents by this expression.

Methods in org.apache.lucene.expressions with parameters of type SortField

Modifier and Type	Method	Description
void	SimpleBindings.add(SortField sortField)	Deprecated.
private DoubleValuesSource	SimpleBindings.fromSortField(SortField field)

Uses of SortField in org.apache.lucene.index

Methods in org.apache.lucene.index that return SortField

Modifier and Type	Method	Description
abstract SortField	SortFieldProvider.readSortField(DataInput in)	Reads a SortField from serialized bytes

Methods in org.apache.lucene.index with parameters of type SortField

Modifier and Type	Method	Description
static void	SortFieldProvider.write(SortField sf, DataOutput output)	Writes a SortField to a DataOutput
abstract void	SortFieldProvider.writeSortField(SortField sf, DataOutput out)	Writes a SortField to a DataOutput This is used to record index sort information in segment headers

Uses of SortField in org.apache.lucene.queries.function

Subclasses of SortField in org.apache.lucene.queries.function

Modifier and Type	Class	Description
(package private) class	ValueSource.ValueSourceSortField

Methods in org.apache.lucene.queries.function that return SortField

Modifier and Type	Method	Description
SortField	ValueSource.getSortField(boolean reverse)	EXPERIMENTAL: This method is subject to change.
SortField	ValueSource.ValueSourceSortField.rewrite(IndexSearcher searcher)

Uses of SortField in org.apache.lucene.queries.function.valuesource

Methods in org.apache.lucene.queries.function.valuesource that return SortField

Modifier and Type	Method	Description
SortField	DoubleFieldSource.getSortField(boolean reverse)
SortField	FloatFieldSource.getSortField(boolean reverse)
SortField	IntFieldSource.getSortField(boolean reverse)
SortField	LongFieldSource.getSortField(boolean reverse)
SortField	MultiValuedDoubleFieldSource.getSortField(boolean reverse)
SortField	MultiValuedFloatFieldSource.getSortField(boolean reverse)
SortField	MultiValuedIntFieldSource.getSortField(boolean reverse)
SortField	MultiValuedLongFieldSource.getSortField(boolean reverse)
SortField	SortedSetFieldSource.getSortField(boolean reverse)

Uses of SortField in org.apache.lucene.search

Subclasses of SortField in org.apache.lucene.search

Modifier and Type	Class	Description
private static class	DoubleValuesSource.DoubleValuesSortField
private static class	LongValuesSource.LongValuesSortField
class	SortedNumericSortField	SortField for SortedNumericDocValues.
class	SortedSetSortField	SortField for SortedSetDocValues.

Fields in org.apache.lucene.search declared as SortField

Modifier and Type	Field	Description
static final SortField	SortField.FIELD_DOC	Represents sorting by document number (index order).
static final SortField	SortField.FIELD_SCORE	Represents sorting by document score (relevance).
protected final SortField[]	FieldValueHitQueue.fields	Stores the sort criteria being used.
(package private) SortField[]	Sort.fields
SortField[]	TopFieldDocs.fields	The fields which were used to sort results by.

Methods in org.apache.lucene.search that return SortField

Modifier and Type	Method	Description
(package private) SortField[]	FieldValueHitQueue.getFields()	Returns the SortFields being used by this hit queue.
SortField[]	Sort.getSort()	Representation of the sort criteria.
SortField	DoubleValuesSource.getSortField(boolean reverse)	Create a sort field based on the value of this producer
SortField	LongValuesSource.getSortField(boolean reverse)	Create a sort field based on the value of this producer
SortField	SortedNumericSortField.Provider.readSortField(DataInput in)
SortField	SortedSetSortField.Provider.readSortField(DataInput in)
SortField	SortField.Provider.readSortField(DataInput in)
SortField	DoubleValuesSource.DoubleValuesSortField.rewrite(IndexSearcher searcher)
SortField	LongValuesSource.LongValuesSortField.rewrite(IndexSearcher searcher)
SortField	SortField.rewrite(IndexSearcher searcher)	Rewrites this SortField, returning a new SortField if a change is made.

Methods in org.apache.lucene.search with parameters of type SortField

Modifier and Type	Method	Description
static <T extends FieldValueHitQueue.Entry> FieldValueHitQueue<T>	FieldValueHitQueue.create(SortField[] fields, int size)	Creates a hit queue sorted by the given list of fields.
private DocIdSetIterator	IndexSortSortedNumericDocValuesRangeQuery.getDocIdSetIterator(SortField sortField, LeafReaderContext context, DocIdSetIterator delegate)	Computes the document IDs that lie within the range [lowerValue, upperValue] by performing binary search on the field's doc values.
private static IndexSortSortedNumericDocValuesRangeQuery.ValueComparator	IndexSortSortedNumericDocValuesRangeQuery.loadComparator(SortField sortField, long topValue, LeafReaderContext context)
void	Sort.setSort(SortField field)	Sets the sort to the given criteria.
void	Sort.setSort(SortField... fields)	Sets the sort to the given criteria in succession: the first SortField is checked first, but if it produces a tie, then the second SortField is used to break the tie, etc.
void	SortedNumericSortField.Provider.writeSortField(SortField sf, DataOutput out)
void	SortedSetSortField.Provider.writeSortField(SortField sf, DataOutput out)
void	SortField.Provider.writeSortField(SortField sf, DataOutput out)

Constructors in org.apache.lucene.search with parameters of type SortField

Modifier	Constructor	Description
private	FieldValueHitQueue(SortField[] fields, int size)
	MultiComparatorsFieldValueHitQueue(SortField[] fields, int size)
	OneComparatorFieldValueHitQueue(SortField[] fields, int size)
	Sort(SortField field)	Sorts by the criteria in the given SortField.
	Sort(SortField... fields)	Sets the sort to the given criteria in succession: the first SortField is checked first, but if it produces a tie, then the second SortField is used to break the tie, etc.
	TopFieldDocs(TotalHits totalHits, ScoreDoc[] scoreDocs, SortField[] fields)	Creates one of these objects.

Uses of SortField in org.apache.lucene.search.grouping

Fields in org.apache.lucene.search.grouping declared as SortField

Modifier and Type	Field	Description
final SortField[]	TopGroups.groupSort	How groups are sorted against each other
final SortField[]	TopGroups.withinGroupSort	How docs are sorted within each group

Constructors in org.apache.lucene.search.grouping with parameters of type SortField

Modifier	Constructor	Description
	TopGroups(SortField[] groupSort, SortField[] withinGroupSort, int totalHitCount, int totalGroupedHitCount, GroupDocs<T>[] groups, float maxScore)

Uses of SortField in org.apache.lucene.search.join

Subclasses of SortField in org.apache.lucene.search.join

Modifier and Type	Class	Description
class	ToParentBlockJoinSortField	A special sort field that allows sorting parent docs based on nested / child level fields.