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

Interface ExtendedSearchSortFactory<PDF extends SearchPredicateFactory>

Type Parameters:

PDF - The type of factory used to create predicates in SortFilterStep.filter(Function).

All Superinterfaces:

SearchSortFactory

All Known Subinterfaces:

ElasticsearchSearchSortFactory, LuceneSearchSortFactory

All Known Implementing Classes:

DelegatingSearchSortFactory

public interface ExtendedSearchSortFactory<PDF extends SearchPredicateFactory>
extends SearchSortFactory

A base interface for subtypes of SearchSortFactory allowing to easily override the predicate factory type for all relevant methods.

Warning: Generic parameters of this type are subject to change, so this type should not be referenced directtly in user code.

Method Summary

Modifier and Type	Method	Description
default DistanceSortOptionsStep<?,PDF>	distance(String absoluteFieldPath, double latitude, double longitude)	Order elements by the distance from the location stored in the specified field to the location specified.
DistanceSortOptionsStep<?,PDF>	distance(String absoluteFieldPath, GeoPoint location)	Order elements by the distance from the location stored in the specified field to the location specified.
FieldSortOptionsStep<?,PDF>	field(String absoluteFieldPath)	Order elements by the value of a specific field.

Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SearchSortFactory

composite, composite, extension, extension, indexOrder, score

Method Detail

field

FieldSortOptionsStep<?,PDF> field(String absoluteFieldPath)

Description copied from interface: SearchSortFactory

Order elements by the value of a specific field.

The default order is ascending.

Specified by:

field in interface SearchSortFactory

Parameters:

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

Returns:

A DSL step where the "field" sort can be defined in more details.

distance

DistanceSortOptionsStep<?,PDF> distance(String absoluteFieldPath,
                                              GeoPoint location)

Description copied from interface: SearchSortFactory

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

The default order is ascending.

Specified by:

distance in interface SearchSortFactory

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 DSL step where the "distance" sort can be defined in more details.

distance

default DistanceSortOptionsStep<?,PDF> distance(String absoluteFieldPath,
                                                      double latitude,
                                                      double longitude)

Description copied from interface: SearchSortFactory

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

The default order is ascending.

Specified by:

distance in interface SearchSortFactory

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 DSL step where the "distance" sort can be defined in more details.