Package io.jmix.search.searching

Interface SearchStrategy<T>

Type Parameters:

T - platform-specific request builder type

All Known Subinterfaces:

ElasticsearchSearchStrategy, OpenSearchSearchStrategy

All Known Implementing Classes:

AbstractElasticSearchStrategy, AbstractOpenSearchStrategy, AbstractSearchStrategy, AllTermsAnyFieldElasticsearchSearchStrategy, AllTermsAnyFieldOpenSearchSearchStrategy, AllTermsSingleFieldElasticsearchSearchStrategy, AllTermsSingleFieldOpenSearchSearchStrategy, AnyTermAnyFieldElasticsearchSearchStrategy, AnyTermAnyFieldOpenSearchSearchStrategy, PhraseElasticsearchSearchStrategy, PhraseOpenSearchSearchStrategy, StartsWithElasticsearchSearchStrategy, StartsWithOpenSearchSearchStrategy

public interface SearchStrategy<T>

Describes the way search context should be processed.

Method Summary

Modifier and Type	Method	Description
default void	configureRequest(SearchRequestContext<T> requestContext)	Configures the provided search request context based on the current search strategy.
String	getName()	Provides the name of this search strategy.

Method Details

getName

String getName()

Provides the name of this search strategy. Name should be unique among all search strategies in application.

Returns:

name

configureRequest

default void configureRequest(SearchRequestContext<T> requestContext)

Configures the provided search request context based on the current search strategy.

Parameters:

requestContext - the SearchRequestContext to configure, which provides the necessary metadata and state of the search preparation process. The type parameter T represents the platform-specific request builder associated with the context.