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

Interface SortContext

@Deprecated public interface SortContext
Deprecated.
Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your sorts using SearchQueryOptionsStep.sort(Function). Refer to the migration guide for more information.
Author:
Emmanuel Bernard emmanuel@hibernate.org, Yoann Rodiere

  • Method Details

    • byScore

      SortScoreContext byScore()
      Deprecated.
      Order elements by their relevance score.

      The default order is descending, i.e. higher scores come first.

      Returns:
      a context instance for building the sort

    • byIndexOrder

      SortOrderTermination byIndexOrder()
      Deprecated.
      Order elements by their internal index order.
      Returns:
      a context instance for building the sort

    • byField

      SortFieldContext byField(String fieldName)
      Deprecated.
      Order elements by the value of a specific field.

      The default order is ascending.

      Parameters:
      fieldName - The name of the index field to sort by
      Returns:
      a context instance for building the sort
      Throws:
      org.hibernate.search.util.common.SearchException - If the sort field type could not be automatically determined.

    • byDistance

      SortDistanceNoFieldContext byDistance()
      Deprecated.
      Order elements by distance.

      The default order is ascending, i.e. shorter distances come first.

      The distance is computed between the value of a field carrying coordinates (to be provided in the next context) and reference coordinates.

      Returns:
      a context instance for building the sort

    • byNative

      SortNativeContext byNative(SortField sortField)
      Deprecated.
      Order element using the native backend API for Lucene.

      The sort order (ascending/descending) is defined in sortField

      Parameters:
      sortField - The sort field to be added to the sort list.
      Returns:
      a context instance for building the sort