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

Packages that use Sort

Package	Description
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.suggest.analyzing	Analyzer based autosuggest.

Uses of Sort in org.apache.lucene.index

Fields in org.apache.lucene.index declared as Sort

Modifier and Type	Field	Description
protected Sort	LiveIndexWriterConfig.indexSort	The sort order to use to write merged segments.
private final Sort	SegmentInfo.indexSort
private final Sort	LeafMetaData.sort
(package private) final Sort	Sorter.sort

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

Modifier and Type	Method	Description
Sort	LiveIndexWriterConfig.getIndexSort()	Get the index-time Sort order, applied to all (flushed and merged) segments.
Sort	SegmentInfo.getIndexSort()	Return the sort order of this segment, or null if the index has no sort.
Sort	LeafMetaData.getSort()	Return the order in which documents from this index are sorted, or null if documents are in no particular order.

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

Modifier and Type	Method	Description
private MergeState.DocMap[]	MergeState.buildDocMaps(List<CodecReader> readers, Sort indexSort)
(package private) static boolean	IndexWriter.isCongruentSort(Sort indexSort, Sort otherSort)	Returns true if indexSort is a prefix of otherSort.
IndexWriterConfig	IndexWriterConfig.setIndexSort(Sort sort)	Set the Sort order to use for all (flushed and merged) segments.
(package private) static MergeState.DocMap[]	MultiSorter.sort(Sort sort, List<CodecReader> readers)	Does a merge sort of the leaves of the incoming reader, returning MergeState.DocMap to map each leaf's documents into the merged segment.
static CheckIndex.Status.IndexSortStatus	CheckIndex.testSort(CodecReader reader, Sort sort, PrintStream infoStream, boolean failFast)	Tests index sort order.
private void	IndexingChain.validateIndexSortDVType(Sort indexSort, String fieldToValidate, DocValuesType dvType)
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sorter.DocMap docMap, Sort sort)	Expert: same as SortingCodecReader.wrap(org.apache.lucene.index.CodecReader, Sort) but operates directly on a Sorter.DocMap.
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sort sort)	Return a sorted view of reader according to the order defined by sort .

Constructors in org.apache.lucene.index with parameters of type Sort

Modifier	Constructor	Description
	LeafMetaData(int createdVersionMajor, Version minVersion, Sort sort, boolean hasBlocks)	Expert: Sole constructor.
	SegmentInfo(Directory dir, Version version, Version minVersion, String name, int maxDoc, boolean isCompoundFile, boolean hasBlocks, Codec codec, Map<String,String> diagnostics, byte[] id, Map<String,String> attributes, Sort indexSort)	Construct a new complete SegmentInfo instance from input.
(package private)	Sorter(Sort sort)	Creates a new Sorter to sort the index with sort

Uses of Sort in org.apache.lucene.search

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

Modifier and Type	Field	Description
static final Sort	Sort.INDEXORDER	Represents sorting by index order.
static final Sort	Sort.RELEVANCE	Represents sorting by computed relevance.
private final Sort	SortRescorer.sort
(package private) final Sort	TopFieldCollector.PagingFieldCollector.sort
(package private) final Sort	TopFieldCollector.SimpleFieldCollector.sort
private final Sort	TopFieldCollectorManager.sort

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

Modifier and Type	Method	Description
Sort	Sort.rewrite(IndexSearcher searcher)	Rewrites the SortFields in this Sort, returning a new Sort if any of the fields changes during their rewriting.

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

Modifier and Type	Method	Description
(package private) static boolean	TopFieldCollector.canEarlyTerminate(Sort searchSort, Sort indexSort)
private static boolean	TopFieldCollector.canEarlyTerminateOnDocId(Sort searchSort)
private static boolean	TopFieldCollector.canEarlyTerminateOnPrefix(Sort searchSort, Sort indexSort)
static TopFieldCollector	TopFieldCollector.create(Sort sort, int numHits, int totalHitsThreshold)	Deprecated. This method is deprecated in favor of the constructor of TopFieldCollectorManager due to its support for concurrency in IndexSearcher
static TopFieldCollector	TopFieldCollector.create(Sort sort, int numHits, FieldDoc after, int totalHitsThreshold)	Deprecated. This method is deprecated in favor of the constructor of TopFieldCollectorManager due to its support for concurrency in IndexSearcher
static CollectorManager<TopFieldCollector,TopFieldDocs>	TopFieldCollector.createSharedManager(Sort sort, int numHits, FieldDoc after, int totalHitsThreshold)	Deprecated. This method is deprecated in favor of the constructor of TopFieldCollectorManager due to its support for concurrency in IndexSearcher
static TopFieldDocs	TopDocs.merge(Sort sort, int start, int topN, TopFieldDocs[] shardHits)	Same as TopDocs.merge(Sort, int, TopFieldDocs[]) but also ignores the top start top docs.
static TopFieldDocs	TopDocs.merge(Sort sort, int start, int topN, TopFieldDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Pass in a custom tie breaker for ordering results
static TopFieldDocs	TopDocs.merge(Sort sort, int topN, TopFieldDocs[] shardHits)	Returns a new TopFieldDocs, containing topN results across the provided TopFieldDocs, sorting by the specified Sort.
private static TopDocs	TopDocs.mergeAux(Sort sort, int start, int size, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Auxiliary method used by the TopDocs.merge(int, org.apache.lucene.search.TopDocs[]) impls.
TopFieldDocs	IndexSearcher.search(Query query, int n, Sort sort)	Search implementation with arbitrary sorting.
TopFieldDocs	IndexSearcher.search(Query query, int n, Sort sort, boolean doDocScores)	Search implementation with arbitrary sorting, plus control over whether hit scores and max score should be computed.
private TopFieldDocs	IndexSearcher.searchAfter(FieldDoc after, Query query, int numHits, Sort sort, boolean doDocScores)
TopDocs	IndexSearcher.searchAfter(ScoreDoc after, Query query, int n, Sort sort)	Finds the top n hits for query where all results are after a previous result (after).
TopFieldDocs	IndexSearcher.searchAfter(ScoreDoc after, Query query, int numHits, Sort sort, boolean doDocScores)	Finds the top n hits for query where all results are after a previous result (after), allowing control over whether hit scores and max score should be computed.

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

Modifier	Constructor	Description
	MergeSortQueue(Sort sort, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)
	PagingFieldCollector(Sort sort, FieldValueHitQueue<FieldValueHitQueue.Entry> queue, FieldDoc after, int numHits, HitsThresholdChecker hitsThresholdChecker, MaxScoreAccumulator minScoreAcc)
	SimpleFieldCollector(Sort sort, FieldValueHitQueue<FieldValueHitQueue.Entry> queue, int numHits, HitsThresholdChecker hitsThresholdChecker, MaxScoreAccumulator minScoreAcc)
	SortRescorer(Sort sort)	Sole constructor.
	TopFieldCollectorManager(Sort sort, int numHits, int totalHitsThreshold)	Creates a new TopFieldCollectorManager from the given arguments, with thread-safe internal states.
	TopFieldCollectorManager(Sort sort, int numHits, FieldDoc after, int totalHitsThreshold)	Creates a new TopFieldCollectorManager from the given arguments, with thread-safe internal states.
	TopFieldCollectorManager(Sort sort, int numHits, FieldDoc after, int totalHitsThreshold, boolean supportsConcurrency)	Creates a new TopFieldCollectorManager from the given arguments.
(package private)	TopFieldLeafCollector(FieldValueHitQueue<FieldValueHitQueue.Entry> queue, Sort sort, LeafReaderContext context)

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

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

Modifier and Type	Field	Description
private final Sort	BlockGroupingCollector.groupSort
private Sort	GroupingSearch.groupSort
private final Sort	TopGroupsCollector.groupSort
protected final Sort	AllGroupHeadsCollector.sort
private Sort	GroupingSearch.sortWithinGroup
private final Sort	TopGroupsCollector.withinGroupSort

Methods in org.apache.lucene.search.grouping with parameters of type Sort

Modifier and Type	Method	Description
TopGroups<?>	BlockGroupingCollector.getTopGroups(Sort withinGroupSort, int groupOffset, int withinGroupOffset, int maxDocsPerGroup)	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, TopGroups.ScoreMergeMode scoreMergeMode)	Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
static <T> AllGroupHeadsCollector<T>	AllGroupHeadsCollector.newCollector(GroupSelector<T> selector, Sort sort)	Create a new AllGroupHeadsCollector based on the type of within-group Sort required
GroupingSearch	GroupingSearch.setGroupSort(Sort groupSort)	Specifies how groups are sorted.
GroupingSearch	GroupingSearch.setSortWithinGroup(Sort sortWithinGroup)	Specified how documents inside a group are sorted.

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

Modifier	Constructor	Description
private	AllGroupHeadsCollector(GroupSelector<T> selector, Sort sort)
	BlockGroupingCollector(Sort groupSort, int topNGroups, boolean needsScores, Weight lastDocPerGroup)	Create the single pass collector.
	FirstPassGroupingCollector(GroupSelector<T> groupSelector, Sort groupSort, int topNGroups)	Create the first pass collector.
	GroupComparator(Sort groupSort)
	GroupMerger(Sort groupSort)
protected	ScoringGroupHeadsCollector(GroupSelector<T> selector, Sort sort)
protected	SortingGroupHead(Sort sort, T groupValue, int doc, LeafReaderContext context, Scorable scorer)
protected	SortingGroupHeadsCollector(GroupSelector<T> selector, Sort sort)
(package private)	TopDocsReducer(Sort withinGroupSort, int maxDocsPerGroup, boolean getMaxScores)
	TopGroupsCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getMaxScores)	Create a new TopGroupsCollector

Uses of Sort in org.apache.lucene.search.suggest.analyzing

Fields in org.apache.lucene.search.suggest.analyzing declared as Sort

Modifier and Type	Field	Description
private static final Sort	AnalyzingInfixSuggester.SORT	How we sort the postings and search results.