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

Class AbstractSearchSortFactory<SR,S extends ExtendedSearchSortFactory<SR,S,PDF>,SC extends SearchSortIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>>

java.lang.Object

org.hibernate.search.engine.search.sort.dsl.spi.AbstractSearchSortFactory<SR,S,SC,PDF>

All Implemented Interfaces:

ExtendedSearchSortFactory<SR,S,PDF>, SearchSortFactory, TypedSearchSortFactory<SR>

public abstract class AbstractSearchSortFactory<SR,S extends ExtendedSearchSortFactory<SR,S,PDF>,SC extends SearchSortIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>>
extends Object
implements ExtendedSearchSortFactory<SR,S,PDF>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SearchSortDslContext<SR,SC,PDF>	dslContext

Constructor Summary

Constructors

Constructor	Description
AbstractSearchSortFactory(SearchSortDslContext<SR,SC,PDF> dslContext)

Method Summary

Modifier and Type	Method	Description
CompositeSortComponentsStep<SR,?>	composite()	Order by a sort composed of several elements.
SortThenStep<SR>	composite(Consumer<? super CompositeSortOptionsCollector<?>> elementContributor)	Order by a sort composed of several elements, which will be defined by the given consumer.
DistanceSortOptionsStep<SR,?,PDF>	distance(String fieldPath, GeoPoint location)	Order elements by the distance from the location stored in the specified field to the location specified.
SearchSortFactoryExtensionIfSupportedStep<SR>	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.
FieldSortOptionsStep<SR,?,PDF>	field(String fieldPath)	Order elements by the value of a specific field.
<T> FieldSortOptionsGenericStep<SR,T,?,?,? extends TypedSearchPredicateFactory<SR>>	field(FieldSortFieldReference<? super SR,T> fieldReference)	Order elements by the value of a specific field.
SortThenStep<SR>	indexOrder()	Order elements by their internal index order.
ScoreSortOptionsStep<SR,?>	score()	Order elements by their relevance score.
protected final SortThenStep<SR>	staticThenStep(SearchSort sort)
final String	toAbsolutePath(String relativeFieldPath)
SortThenStep<SR>	withParameters(Function<? super NamedValues,? extends SortFinalStep> sortCreator)	Delegating sort that creates the actual sort at query create time and provides access to query parameters.

Methods inherited from class java.lang.Object

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

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

distance, distance, distance, withRoot

Field Details

dslContext

protected final SearchSortDslContext<SR,SC extends SearchSortIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>> dslContext

Constructor Details

AbstractSearchSortFactory

public AbstractSearchSortFactory(SearchSortDslContext<SR,SC,PDF> dslContext)

Method Details

score

public ScoreSortOptionsStep<SR,?> score()

Description copied from interface: TypedSearchSortFactory

Order elements by their relevance score.

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

Specified by:

score in interface SearchSortFactory

Specified by:

score in interface TypedSearchSortFactory<SR>

Returns:

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

indexOrder

public SortThenStep<SR> indexOrder()

Description copied from interface: TypedSearchSortFactory

Order elements by their internal index order.

Specified by:

indexOrder in interface SearchSortFactory

Specified by:

indexOrder in interface TypedSearchSortFactory<SR>

Returns:

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

field

public FieldSortOptionsStep<SR,?,PDF> field(String fieldPath)

Description copied from interface: TypedSearchSortFactory

Order elements by the value of a specific field.

The default order is ascending.

Specified by:

field in interface ExtendedSearchSortFactory<SR,S extends ExtendedSearchSortFactory<SR,S,PDF>,SC extends SearchSortIndexScope<?>>

Specified by:

field in interface SearchSortFactory

Specified by:

field in interface TypedSearchSortFactory<SR>

Parameters:

fieldPath - The path to the index field to sort by.

Returns:

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

field

public <T>
FieldSortOptionsGenericStep<SR,T,?,?,? extends TypedSearchPredicateFactory<SR>> field(FieldSortFieldReference<? super SR,T> fieldReference)

Description copied from interface: TypedSearchSortFactory

Order elements by the value of a specific field.

The default order is ascending.

Specified by:

field in interface TypedSearchSortFactory<SR>

Parameters:

fieldReference - The field reference representing a definition of the index field to sort by.

Returns:

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

distance

public DistanceSortOptionsStep<SR,?,PDF> distance(String fieldPath,
 GeoPoint location)

Description copied from interface: TypedSearchSortFactory

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 ExtendedSearchSortFactory<SR,S extends ExtendedSearchSortFactory<SR,S,PDF>,SC extends SearchSortIndexScope<?>>

Specified by:

distance in interface SearchSortFactory

Specified by:

distance in interface TypedSearchSortFactory<SR>

Parameters:

fieldPath - The path to the index field containing the location to compute the distance from.

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.

composite

public CompositeSortComponentsStep<SR,?> composite()

Description copied from interface: TypedSearchSortFactory

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 TypedSearchSortFactory.composite(Consumer)

Specified by:

composite in interface SearchSortFactory

Specified by:

composite in interface TypedSearchSortFactory<SR>

Returns:

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

composite

public SortThenStep<SR> composite(Consumer<? super CompositeSortOptionsCollector<?>> elementContributor)

Description copied from interface: TypedSearchSortFactory

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.field( "category" ) );
    if ( someInput != null ) {
        c.add( f.distance( "location", someInput.getLatitude(), someInput.getLongitude() );
    }
    c.add( f.indexOrder() );
 } )
 

Specified by:

composite in interface SearchSortFactory

Specified by:

composite in interface TypedSearchSortFactory<SR>

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.

withParameters

public SortThenStep<SR> withParameters(Function<? super NamedValues,? extends SortFinalStep> sortCreator)

Description copied from interface: TypedSearchSortFactory

Delegating sort that creates the actual sort at query create time and provides access to query parameters.

Which sort exactly to create is defined by a function passed to the arguments of this sort.

Specified by:

withParameters in interface SearchSortFactory

Specified by:

withParameters in interface TypedSearchSortFactory<SR>

Parameters:

sortCreator - The function defining an actual sort to apply.

Returns:

A final DSL step in a parameterized sort definition.

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<SR> extension()

Description copied from interface: TypedSearchSortFactory

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

Specified by:

extension in interface TypedSearchSortFactory<SR>

Returns:

A DSL step.

toAbsolutePath

public final String toAbsolutePath(String relativeFieldPath)

Specified by:

toAbsolutePath in interface SearchSortFactory

Parameters:

relativeFieldPath - The path to a field, relative to the root of this factory.

Returns:

The absolute path of the field, for use in native sorts for example. Note the path is returned even if the field doesn't exist.

staticThenStep

protected final SortThenStep<SR> staticThenStep(SearchSort sort)