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

Interface SearchSortDslContext<F extends SearchSortBuilderFactory<?,B>,B,PDF extends SearchPredicateFactory>

Type Parameters:

F - The type of sort factory.

B - The implementation type of builders. This type is backend-specific. See SearchSortBuilder.toImplementation().

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

public interface SearchSortDslContext<F extends SearchSortBuilderFactory<?,B>,B,PDF extends SearchPredicateFactory>

Represents the current context in the search DSL, including in particular the sort builder factory and the knowledge of previous sorts chained using SortThenStep.then().

Method Summary

Modifier and Type	Method and Description
SearchSortDslContext<?,B,PDF>	append(B builder) Create a new context with a sort builder appended.
F	builderFactory()
PDF	predicateFactory()
SearchSort	toSort() Create a SearchSort instance matching the definition given in the previous DSL steps.
<PDF2 extends SearchPredicateFactory> SearchSortDslContext<F,B,PDF2>	withExtendedPredicateFactory(SearchPredicateFactoryExtension<PDF2> extension)

Method Detail

builderFactory

F builderFactory()

Returns:

The sort builder factory. Will always return the exact same instance.

append

SearchSortDslContext<?,B,PDF> append(B builder)

Create a new context with a sort builder appended.

Parameters:

builder - The builder to add.

Returns:

A new DSL context, with the given builder appended.

predicateFactory

PDF predicateFactory()

Returns:

The predicate factory. Will always return the exact same instance.

withExtendedPredicateFactory

<PDF2 extends SearchPredicateFactory> SearchSortDslContext<F,B,PDF2> withExtendedPredicateFactory(SearchPredicateFactoryExtension<PDF2> extension)

Type Parameters:

PDF2 - The type of the new predicate factory.

Parameters:

extension - The extension to apply to the predicate factory.

Returns:

A new context, identical to this except for the predicate factory which is extended.

toSort

SearchSort toSort()

Create a SearchSort instance matching the definition given in the previous DSL steps.

Returns:

The SearchSort instance.