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

Interface SearchSortContainerContext

All Known Implementing Classes:

DelegatingSearchSortContainerContext

public interface SearchSortContainerContext

A context allowing to add a sort element.

Author:

Emmanuel Bernard emmanuel@hibernate.org, Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
NonEmptySortContext	by(SearchSort sort) Order by the given sort.
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.
FieldSortContext	byRawField(String absoluteFieldPath) Order elements by the value of a specific raw field.
ScoreSortContext	byScore() Order elements by their relevance score.
SearchSortContainerExtensionContext	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(SearchSortContainerContextExtension<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.

byRawField

FieldSortContext byRawField(String absoluteFieldPath)

Order elements by the value of a specific raw field.

The default order is ascending.

Using this method instead of byField(String) will disable some of the conversion applied to arguments to FieldSortMissingValueContext.use(Object), allowing to pass values directly to the backend.

This is useful when the type of the indexed property is not the same as the type of search parameters. For example one may use a custom bridge implementing ValueBridge<MyType, String> to translate a property from a custom type to a string when indexing. When targeting that field with byField, Hibernate Search will expect arguments to FieldSortMissingValueContext.use(Object) to be instances of the custom type; with byRawField, it will expect strings.

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.

See Also:

byField(String)

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.

by

NonEmptySortContext by(SearchSort sort)

Order by the given sort.

Parameters:

sort - A previously-built SearchSort object.

Returns:

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

extension

<T> T extension(SearchSortContainerContextExtension<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

SearchSortContainerExtensionContext 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(SearchSortContainerContextExtension) method instead.

Returns:

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