Class SortedSetSortField
SortedSetDocValues.
A SortedSetDocValues contains multiple values for a field, so sorting with this technique "selects" a value as the representative sort value for the document.
By default, the minimum value in the set is selected as the sort value, but this can be customized. Selectors other than the default do have some limitations to ensure that all selections happen in constant-time for performance.
Like sorting by string, this also supports sorting missing values as first or last, via setMissingValue(Object).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA SortFieldProvider for this sortNested classes/interfaces inherited from class org.apache.lucene.search.SortField
SortField.Type -
Field Summary
Fields inherited from class org.apache.lucene.search.SortField
FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST -
Constructor Summary
ConstructorsConstructorDescriptionSortedSetSortField(String field, boolean reverse) Creates a sort, possibly in reverse, by the minimum value in the set for the document.SortedSetSortField(String field, boolean reverse, SortedSetSelector.Type selector) Creates a sort, possibly in reverse, specifying how the sort value from the document's set is selected. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns true ifois equal to this.getComparator(int numHits, Pruning pruning) Returns theFieldComparatorto use for sorting.Returns anIndexSorterused for sorting index segments by this SortField.Returns the selector in use for this sortinthashCode()Returns a hash code for thisSortFieldinstance.voidsetMissingValue(Object missingValue) Set how missing values (the empty set) are sorted.toString()Methods inherited from class org.apache.lucene.search.SortField
getBytesComparator, getComparatorSource, getField, getMissingValue, getOptimizeSortWithIndexedData, getOptimizeSortWithPoints, getReverse, getType, needsScores, readType, rewrite, setBytesComparator, setOptimizeSortWithIndexedData, setOptimizeSortWithPoints
-
Constructor Details
-
SortedSetSortField
Creates a sort, possibly in reverse, by the minimum value in the set for the document.- Parameters:
field- Name of field to sort by. Must not be null.reverse- True if natural order should be reversed.
-
SortedSetSortField
Creates a sort, possibly in reverse, specifying how the sort value from the document's set is selected.- Parameters:
field- Name of field to sort by. Must not be null.reverse- True if natural order should be reversed.selector- custom selector type for choosing the sort value from the set.NOTE: selectors other than
SortedSetSelector.Type.MINrequire optional codec support.
-
-
Method Details
-
getSelector
Returns the selector in use for this sort -
hashCode
public int hashCode()Description copied from class:SortFieldReturns a hash code for thisSortFieldinstance. If aFieldComparatorSourcewas provided, it must properly implement hashCode (unless a singleton is always used). -
equals
Description copied from class:SortFieldReturns true ifois equal to this. If aFieldComparatorSourcewas provided, it must properly implement equals (unless a singleton is always used). -
toString
-
setMissingValue
Set how missing values (the empty set) are sorted.Note that this must be
SortField.STRING_FIRSTorSortField.STRING_LAST.- Overrides:
setMissingValuein classSortField
-
getComparator
Description copied from class:SortFieldReturns theFieldComparatorto use for sorting.- Overrides:
getComparatorin classSortField- Parameters:
numHits- number of top hits the queue will storepruning- controls how can the comparator to skip documents viaLeafFieldComparator.competitiveIterator()- Returns:
FieldComparatorto use when sorting
-
getIndexSorter
Description copied from class:SortFieldReturns anIndexSorterused for sorting index segments by this SortField.If the SortField cannot be used for index sorting (for example, if it uses scores or other query-dependent values) then this method should return
nullSortFields that implement this method should also implement a companion
SortFieldProviderto serialize and deserialize the sort in index segment headers- Overrides:
getIndexSorterin classSortField
-