Uses of Class org.apache.lucene.search.Sort (Lucene 3.6.2 API)

Packages that use Sort
Package	Description
org.apache.lucene.benchmark.byTask.tasks	Extendable benchmark tasks.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.
org.apache.lucene.search.join	This modules support index-time and query-time joins.

Uses of Sort in org.apache.lucene.benchmark.byTask.tasks

Methods in org.apache.lucene.benchmark.byTask.tasks that return Sort
Modifier and Type Method Description

protected Sort ReadTask.getSort()

Sort SearchWithSortTask.getSort()

Uses of Sort in org.apache.lucene.search

Fields in org.apache.lucene.search declared as Sort
Modifier and Type	Field	Description
`static Sort`	Sort.`INDEXORDER`	Represents sorting by index order.
`static Sort`	Sort.`RELEVANCE`	Represents sorting by computed relevance.

Methods in org.apache.lucene.search with parameters of type Sort
Modifier and Type	Method	Description
`static TopFieldCollector`	TopFieldCollector.`create(Sort sort, int numHits, boolean fillFields, boolean trackDocScores, boolean trackMaxScore, boolean docsScoredInOrder)`	Creates a new `TopFieldCollector` from the given arguments.
`static TopDocs`	TopDocs.`merge(Sort sort, int topN, TopDocs[] shardHits)`	Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by the specified `Sort`.
`TopFieldDocs`	CheckHits.ExplanationAssertingSearcher.`search(Query query, Filter filter, int n, Sort sort)`
`TopFieldDocs`	IndexSearcher.`search(Query query, int n, Sort sort)`	Search implementation with arbitrary sorting and no filter.
`TopFieldDocs`	IndexSearcher.`search(Query query, Filter filter, int n, Sort sort)`	Search implementation with arbitrary sorting.
`TopFieldDocs`	IndexSearcher.`search(Weight weight, Filter filter, int nDocs, Sort sort)`	Expert: Low-level search implementation with arbitrary sorting.
`protected TopFieldDocs`	IndexSearcher.`search(Weight weight, Filter filter, int nDocs, Sort sort, boolean fillFields)`	Just like `IndexSearcher.search(Weight, Filter, int, Sort)`, but you choose whether or not the fields in the returned `FieldDoc` instances should be set by specifying fillFields.
`TopFieldDocs`	MultiSearcher.`search(Weight weight, Filter filter, int n, Sort sort)`	Deprecated.
`TopFieldDocs`	ParallelMultiSearcher.`search(Weight weight, Filter filter, int nDocs, Sort sort)`	Deprecated. A search implementation allowing sorting which spans a new thread for each Searchable, waits for each search to complete and merges the results back together.
`TopFieldDocs`	RemoteSearchable.`search(Weight weight, Filter filter, int n, Sort sort)`	Deprecated.
`TopFieldDocs`	Searchable.`search(Weight weight, Filter filter, int n, Sort sort)`	Deprecated. Expert: Low-level search implementation with arbitrary sorting.
`TopFieldDocs`	Searcher.`search(Query query, int n, Sort sort)`	Deprecated. Search implementation with arbitrary sorting and no filter.
`TopFieldDocs`	Searcher.`search(Query query, Filter filter, int n, Sort sort)`	Deprecated. Search implementation with arbitrary sorting.
`abstract TopFieldDocs`	Searcher.`search(Weight weight, Filter filter, int n, Sort sort)`	Deprecated.

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

Methods in org.apache.lucene.search.grouping with parameters of type Sort
Modifier and Type	Method	Description
`static AbstractAllGroupHeadsCollector`	TermAllGroupHeadsCollector.`create(String groupField, Sort sortWithinGroup)`	Creates an `AbstractAllGroupHeadsCollector` instance based on the supplied arguments.
`static AbstractAllGroupHeadsCollector`	TermAllGroupHeadsCollector.`create(String groupField, Sort sortWithinGroup, int initialSize)`	Creates an `AbstractAllGroupHeadsCollector` instance based on the supplied arguments.
`TopGroups`	BlockGroupingCollector.`getTopGroups(Sort withinGroupSort, int groupOffset, int withinGroupOffset, int maxDocsPerGroup, boolean fillSortFields)`	Returns the grouped results.
`static <T> Collection<SearchGroup<T>>`	SearchGroup.`merge(List<Collection<SearchGroup<T>>> topGroups, int offset, int topN, Sort groupSort)`	Merges multiple collections of top groups, for example obtained from separate index shards.
`static <T> TopGroups<T>`	TopGroups.`merge(TopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN)`	Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.

Constructors in org.apache.lucene.search.grouping with parameters of type Sort
Constructor	Description
`AbstractFirstPassGroupingCollector(Sort groupSort, int topNGroups)`	Create the first pass collector.
`AbstractSecondPassGroupingCollector(Collection<SearchGroup<GROUP_VALUE_TYPE>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getScores, boolean getMaxScores, boolean fillSortFields)`
`BlockGroupingCollector(Sort groupSort, int topNGroups, boolean needsScores, Filter lastDocPerGroup)`	Create the single pass collector.
`TermFirstPassGroupingCollector(String groupField, Sort groupSort, int topNGroups)`	Create the first pass collector.
`TermSecondPassGroupingCollector(String groupField, Collection<SearchGroup<String>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getScores, boolean getMaxScores, boolean fillSortFields)`

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

Methods in org.apache.lucene.search.join with parameters of type Sort
Modifier and Type	Method	Description
`TopGroups<Integer>`	ToParentBlockJoinCollector.`getTopGroups(ToParentBlockJoinQuery query, Sort withinGroupSort, int offset, int maxDocsPerGroup, int withinGroupOffset, boolean fillSortFields)`	Return the TopGroups for the specified BlockJoinQuery.

Constructors in org.apache.lucene.search.join with parameters of type Sort
Constructor	Description
`ToParentBlockJoinCollector(Sort sort, int numParentHits, boolean trackScores, boolean trackMaxScore)`