Class SortedNumericSortField


  • public class SortedNumericSortField
    extends SortField
    SortField for SortedNumericDocValues.

    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
    • 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 values
        reverse - 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 values
        reverse - 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
      • hashCode

        public int hashCode()
        Description copied from class: SortField
        Returns a hash code for this SortField instance. If a FieldComparatorSource was provided, it must properly implement hashCode (unless a singleton is always used).
        Overrides:
        hashCode in class SortField
      • equals

        public boolean equals​(Object obj)
        Description copied from class: SortField
        Returns true if o is equal to this. If a FieldComparatorSource was provided, it must properly implement equals (unless a singleton is always used).
        Overrides:
        equals in class SortField
      • setMissingValue

        public void setMissingValue​(Object missingValue)
        Description copied from class: SortField
        Set the value to use for documents that don't have a value.
        Overrides:
        setMissingValue in class SortField
      • getIndexSorter

        public IndexSorter getIndexSorter()
        Description copied from class: SortField
        Returns an IndexSorter used 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 null

        SortFields that implement this method should also implement a companion SortFieldProvider to serialize and deserialize the sort in index segment headers

        Overrides:
        getIndexSorter in class SortField