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

Class DelegatingSearchSortFactory

java.lang.Object

org.hibernate.search.engine.search.dsl.sort.spi.DelegatingSearchSortFactory

All Implemented Interfaces:

SearchSortFactory

public class DelegatingSearchSortFactory
extends Object
implements SearchSortFactory

A delegating SearchSortFactory.

Mainly useful when implementing a SearchSortFactoryExtension.

Constructor Summary

Constructors

Constructor and Description
DelegatingSearchSortFactory(SearchSortFactory delegate)

Method Summary

Modifier and Type	Method and Description
CompositeSortComponentsStep	byComposite() Order by a sort composed of several elements.
SortThenStep	byComposite(Consumer<? super CompositeSortComponentsStep> elementContributor) Order by a sort composed of several elements, which will be defined by the given consumer.
DistanceSortOptionsStep	byDistance(String absoluteFieldPath, double latitude, double longitude) Order elements by the distance from the location stored in the specified field to the location specified.
DistanceSortOptionsStep	byDistance(String absoluteFieldPath, GeoPoint location) Order elements by the distance from the location stored in the specified field to the location specified.
FieldSortOptionsStep	byField(String absoluteFieldPath) Order elements by the value of a specific field.
SortThenStep	byIndexOrder() Order elements by their internal index order.
ScoreSortOptionsStep	byScore() Order elements by their relevance score.
SearchSortFactoryExtensionIfSupportedStep	extension() Create a DSL step allowing multiple attempts to apply extensions one after the other, failing only if none of the extensions is supported.
<T> T	extension(SearchSortFactoryExtension<T> extension) Extend the current factory with the given extension, resulting in an extended factory offering different types of sorts.
protected SearchSortFactory	getDelegate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingSearchSortFactory

public DelegatingSearchSortFactory(SearchSortFactory delegate)

Method Detail

byScore

public ScoreSortOptionsStep byScore()

Description copied from interface: SearchSortFactory

Order elements by their relevance score.

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

Specified by:

byScore in interface SearchSortFactory

Returns:

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

byIndexOrder

public SortThenStep byIndexOrder()

Description copied from interface: SearchSortFactory

Order elements by their internal index order.

Specified by:

byIndexOrder in interface SearchSortFactory

Returns:

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

byField

public FieldSortOptionsStep byField(String absoluteFieldPath)

Description copied from interface: SearchSortFactory

Order elements by the value of a specific field.

The default order is ascending.

Specified by:

byField 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.

byDistance

public DistanceSortOptionsStep byDistance(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:

byDistance 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.

byDistance

public DistanceSortOptionsStep byDistance(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:

byDistance 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.

byComposite

public CompositeSortComponentsStep byComposite()

Description copied from interface: SearchSortFactory

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 SortThenStep.then(). This method is mainly useful to mix imperative and declarative style when building sorts. See SearchSortFactory.byComposite(Consumer)

Specified by:

byComposite in interface SearchSortFactory

Returns:

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

byComposite

public SortThenStep byComposite(Consumer<? super CompositeSortComponentsStep> elementContributor)

Description copied from interface: SearchSortFactory

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() );
 } )
 

Specified by:

byComposite in interface SearchSortFactory

Parameters:

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

Returns:

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

extension

public <T> T extension(SearchSortFactoryExtension<T> extension)

Description copied from interface: SearchSortFactory

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

Specified by:

extension in interface SearchSortFactory

Type Parameters:

T - The type of factory provided by the extension.

Parameters:

extension - The extension to the sort DSL.

Returns:

The extended factory.

extension

public SearchSortFactoryExtensionIfSupportedStep extension()

Description copied from interface: SearchSortFactory

Create a DSL step allowing multiple attempts to apply 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 SearchSortFactory.extension(SearchSortFactoryExtension) method instead.

Specified by:

extension in interface SearchSortFactory

Returns:

A DSL step.

getDelegate

protected SearchSortFactory getDelegate()