Package org.hibernate.search.query.dsl.sort

Interface SortMissingValueContext<T>

@Deprecated public interface SortMissingValueContext<T>
Deprecated.
See the deprecation note on SortContext.
Author:
Emmanuel Bernard emmanuel@hibernate.org, Yoann Rodiere

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    sortFirst()
    Deprecated.
    Put documents with missing values first in the sorting.
    T
    sortLast()
    Deprecated.
    Put documents with missing values last in the sorting.
    T
    use(Object value)
    Deprecated.
    When documents are missing a value on the sort field, use the given value instead.

  • Method Details

    • sortLast

      T sortLast()
      Deprecated.
      Put documents with missing values last in the sorting.

      This instruction is independent of whether the sort is being ascending or descending.

      Returns:
      the initial context for method chaining

    • sortFirst

      T sortFirst()
      Deprecated.
      Put documents with missing values first in the sorting.

      This instruction is independent of whether the sort is being ascending or descending.

      Returns:
      the initial context for method chaining

    • use

      T use(Object value)
      Deprecated.
      When documents are missing a value on the sort field, use the given value instead.

      Lucene sort API limits this feature to numeric fields. As Hibernate Search sorts are currently based on the Lucene API underneath, this is only available for numeric fields for all the indexing services, Elasticsearch included.

      Field bridges, if any, will be ignored. Thus the actual numeric value must be provided.

      Parameters:
      value - The value to use as a replacements when the field has no value in a document.
      Returns:
      the initial context for method chaining
      Throws:
      org.hibernate.search.util.common.SearchException - If the field is not numeric.