Package io.jmix.searchopensearch.searching.strategy

Interface OpenSearchSearchStrategy

All Superinterfaces:

SearchStrategy<org.opensearch.client.opensearch.core.SearchRequest.Builder>

All Known Implementing Classes:

AbstractOpenSearchStrategy, AllTermsAnyFieldOpenSearchSearchStrategy, AllTermsSingleFieldOpenSearchSearchStrategy, AnyTermAnyFieldOpenSearchSearchStrategy, PhraseOpenSearchSearchStrategy, StartsWithOpenSearchSearchStrategy

public interface OpenSearchSearchStrategy
extends SearchStrategy<org.opensearch.client.opensearch.core.SearchRequest.Builder>

A OpenSearch-specific extension of the common {link @SearchStrategy} interface

Method Summary

Modifier and Type	Method	Description
default void	configureRequest(SearchRequestContext<org.opensearch.client.opensearch.core.SearchRequest.Builder> requestContext)	Configures the provided search request context based on the current search strategy.
void	configureRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder, SearchContext searchContext)	Deprecated, for removal: This API element is subject to removal in a future version. Because the new method with a more flexible signature is created.

Methods inherited from interface io.jmix.search.searching.SearchStrategy

getName

Method Details

configureRequest

@Deprecated(since="2.7",
            forRemoval=true)
void configureRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder,
 SearchContext searchContext)

Deprecated, for removal: This API element is subject to removal in a future version.

Because the new method with a more flexible signature is created. Use configureRequest(SearchRequestContext)

Configures OpenSearch SearchRequest.

The main step - create appropriate query based on provided SearchContext and set it to request.

Configuration of another request parameters is optional.

Highlighting, size and offset shouldn't be configured here - these parameters will be overwritten.

Parameters:

requestBuilder - allows to configure search request

searchContext - contains details about search being performed

configureRequest

default void configureRequest(SearchRequestContext<org.opensearch.client.opensearch.core.SearchRequest.Builder> requestContext)

Description copied from interface: SearchStrategy

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

Specified by:

configureRequest in interface SearchStrategy<org.opensearch.client.opensearch.core.SearchRequest.Builder>

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.