Package org.apache.lucene.search
Class SortedNumericSortField
- java.lang.Object
-
- org.apache.lucene.search.SortField
-
- org.apache.lucene.search.SortedNumericSortField
-
public class SortedNumericSortField extends SortField
SortField forSortedNumericDocValues.A SortedNumericDocValues 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 list is selected as the sort value, but this can be customized.
Like sorting by string, this also supports sorting missing values as first or last, via
setMissingValue(Object).- See Also:
SortedNumericSelector
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSortedNumericSortField.ProviderA SortFieldProvider for this sort field-
Nested 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
Constructors Constructor Description SortedNumericSortField(String field, SortField.Type type)Creates a sort, by the minimum value in the set for the document.SortedNumericSortField(String field, SortField.Type type, boolean reverse)Creates a sort, possibly in reverse, by the minimum value in the set for the document.SortedNumericSortField(String field, SortField.Type type, boolean reverse, SortedNumericSelector.Type selector)Creates a sort, possibly in reverse, specifying how the sort value from the document's set is selected.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Returns true ifois equal to this.FieldComparator<?>getComparator(int numHits, Pruning pruning)Returns theFieldComparatorto use for sorting.IndexSortergetIndexSorter()Returns anIndexSorterused for sorting index segments by this SortField.SortField.TypegetNumericType()Returns the numeric type in use for this sortSortedNumericSelector.TypegetSelector()Returns the selector in use for this sortinthashCode()Returns a hash code for thisSortFieldinstance.voidsetMissingValue(Object missingValue)Set the value to use for documents that don't have a value.StringtoString()-
Methods inherited from class org.apache.lucene.search.SortField
getBytesComparator, getComparatorSource, getField, getMissingValue, getOptimizeSortWithIndexedData, getOptimizeSortWithPoints, getReverse, getType, needsScores, readType, rewrite, setBytesComparator, setOptimizeSortWithIndexedData, setOptimizeSortWithPoints
-
-
-
-
Constructor Detail
-
SortedNumericSortField
public SortedNumericSortField(String field, SortField.Type type)
Creates a sort, by the minimum value in the set for the document.- Parameters:
field- Name of field to sort by. Must not be null.type- Type of values
-
SortedNumericSortField
public SortedNumericSortField(String field, SortField.Type type, boolean reverse)
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.type- Type of valuesreverse- True if natural order should be reversed.
-
SortedNumericSortField
public SortedNumericSortField(String field, SortField.Type type, boolean reverse, SortedNumericSelector.Type selector)
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.type- Type of valuesreverse- True if natural order should be reversed.selector- custom selector type for choosing the sort value from the set.
-
-
Method Detail
-
getNumericType
public SortField.Type getNumericType()
Returns the numeric type in use for this sort
-
getSelector
public SortedNumericSelector.Type 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
public boolean equals(Object obj)
Description copied from class:SortFieldReturns true ifois equal to this. If aFieldComparatorSourcewas provided, it must properly implement equals (unless a singleton is always used).
-
setMissingValue
public void setMissingValue(Object missingValue)
Description copied from class:SortFieldSet the value to use for documents that don't have a value.- Overrides:
setMissingValuein classSortField
-
getComparator
public FieldComparator<?> getComparator(int numHits, Pruning pruning)
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
public IndexSorter 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
-
-