Class SortedSetSortField


  • public class SortedSetSortField
    extends SortField
    SortField for 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:
    SortedSetSelector
    • Constructor Detail

      • SortedSetSortField

        public SortedSetSortField​(String field,
                                  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.
        reverse - True if natural order should be reversed.
      • SortedSetSortField

        public 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.
        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.MIN require optional codec support.