org.hibernate.search.engine.search.dsl.sort

Interface SearchSortFactoryContext

All Known Implementing Classes:

DelegatingSearchSortFactoryContext

public interface SearchSortFactoryContext

A context allowing to specify the type of a sort.

Author:

Emmanuel Bernard emmanuel@hibernate.org

Method Summary

Modifier and Type	Method and Description
CompositeSortContext	byComposite() Order by a sort composed of several elements.
NonEmptySortContext	byComposite(Consumer<? super CompositeSortContext> elementContributor) Order by a sort composed of several elements, which will be defined by the given consumer.
default DistanceSortContext	byDistance(String absoluteFieldPath, double latitude, double longitude) Order elements by the distance from the location stored in the specified field to the location specified.
DistanceSortContext	byDistance(String absoluteFieldPath, GeoPoint location) Order elements by the distance from the location stored in the specified field to the location specified.
FieldSortContext	byField(String absoluteFieldPath) Order elements by the value of a specific field.
NonEmptySortContext	byIndexOrder() Order elements by their internal index order.
ScoreSortContext	byScore() Order elements by their relevance score.
SearchSortFactoryExtensionContext	extension() Create a context allowing to try to apply multiple extensions one after the other, failing only if none of the extensions is supported.
<T> T	extension(SearchSortFactoryContextExtension<T> extension) Extend the current context with the given extension, resulting in an extended context offering different types of sorts.

Method Detail

byScore

ScoreSortContext byScore()

Order elements by their relevance score.

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

Returns:

A context allowing to define the sort more precisely, chain other sorts or get the resulting sort.

byIndexOrder

NonEmptySortContext byIndexOrder()

Order elements by their internal index order.

Returns:

A context allowing to chain other sorts or get the resulting sort.

byField

FieldSortContext byField(String absoluteFieldPath)

Order elements by the value of a specific field.

The default order is ascending.

Parameters:

absoluteFieldPath - The absolute path of the index field to sort by

Returns:

A context allowing to define the sort more precisely, chain other sorts or get the resulting sort.

Throws:

SearchException - If the sort field type could not be automatically determined.

byDistance

DistanceSortContext byDistance(String absoluteFieldPath,
                               GeoPoint location)

Order elements by the distance from the location stored in the specified field to the location specified.

The default order is ascending.

Parameters:

absoluteFieldPath - The absolute path of the indexed location field to sort by.

location - The location to which we want to compute the distance.

Returns:

A context allowing to define the sort more precisely, chain other sorts or get the resulting sort.

Throws:

SearchException - If the field type does not constitute a valid location.

byDistance

default DistanceSortContext byDistance(String absoluteFieldPath,
                                       double latitude,
                                       double longitude)

Order elements by the distance from the location stored in the specified field to the location specified.

The default order is ascending.

Parameters:

absoluteFieldPath - The absolute path of the indexed location field to sort by.

latitude - The latitude of the location to which we want to compute the distance.

longitude - The longitude of the location to which we want to compute the distance.

Returns:

A context allowing to define the sort more precisely, chain other sorts or get the resulting sort.

Throws:

SearchException - If the field type does not constitute a valid location.

byComposite

CompositeSortContext byComposite()

Order by a sort composed of several elements.

Note that, in general, calling this method is not necessary as you can chain sorts by calling NonEmptySortContext.then(). This method is mainly useful to mix imperative and declarative style when building sorts. See byComposite(Consumer)

Returns:

A context allowing to define the sort more precisely, chain other sorts or get the resulting sort.

byComposite

NonEmptySortContext byComposite(Consumer<? super CompositeSortContext> elementContributor)

Order by a sort composed of several elements, which will be defined by the given consumer.

Best used with lambda expressions.

This is mainly useful to mix imperative and declarative style when building sorts, e.g.:

 f.composite( c -> {
    c.add( f.byField( "category" ) );
    if ( someInput != null ) {
        c.add( f.byDistance( "location", someInput.getLatitude(), someInput.getLongitude() );
    }
    c.add( f.byIndexOrder() );
 } )
 

Parameters:

elementContributor - A consumer that will add elements to the context passed in parameter. Should generally be a lambda expression.

Returns:

A context allowing chain other sorts or get the resulting sort.

extension

<T> T extension(SearchSortFactoryContextExtension<T> extension)

Extend the current context with the given extension, resulting in an extended context offering different types of sorts.

Type Parameters:

T - The type of context provided by the extension.

Parameters:

extension - The extension to the sort DSL.

Returns:

The extended context.

Throws:

SearchException - If the extension cannot be applied (wrong underlying backend, ...).

extension

SearchSortFactoryExtensionContext extension()

Create a context allowing to try to apply multiple extensions one after the other, failing only if none of the extensions is supported.

If you only need to apply a single extension and fail if it is not supported, use the simpler extension(SearchSortFactoryContextExtension) method instead.

Returns:

A context allowing to define the extensions to attempt, and the corresponding sorts.