Package io.jmix.search.searching

Interface SearchQueryConfigurer<RB,QB,OB>

Type Parameters:

RB - type of platform-specific request builder

QB - type of platform-specific query builder

OB - type of platform-specific object builder

All Known Implementing Classes:

AbstractSearchQueryConfigurer, ElasticSearchQueryConfigurer, OpenSearchQueryConfigurer

public interface SearchQueryConfigurer<RB,QB,OB>

Provides a mechanism for configuring search queries against a search server. The SearchQueryConfigurer interface allows for building and customizing search request queries using the provided request context, query configuration, and optional subfields. The query is constructed for one or more indexes based on the configured scope, with optional parameters enabling enhanced flexibility in request customization.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB>	An interface for applying business-specific configurations to a query.

Method Summary

Modifier and Type	Method	Description
void	configureRequest(SearchRequestContext<RB> requestContext, SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer)	Configures a search request using the provided request context and query configuration logic.
void	configureRequest(SearchRequestContext<RB> requestContext, VirtualSubfieldsProvider virtualSubfieldsProvider, SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer)	Configures request for the data querying from the search server.

Method Details

configureRequest

void configureRequest(SearchRequestContext<RB> requestContext,
 SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer)

Configures a search request using the provided request context and query configuration logic.

Parameters:

requestContext - the context containing request building information, including the request builder and processing state management

businessQueryConfigurer - an interface for building and applying business-specific query configurations to a single index

configureRequest

void configureRequest(SearchRequestContext<RB> requestContext,
 VirtualSubfieldsProvider virtualSubfieldsProvider,
 SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer)

Configures request for the data querying from the search server. Provides an ability to add subfields to the query.

Parameters:

requestContext - request context for the request building.

virtualSubfieldsProvider - provider that provides additional subfields by the VirtualSubfieldsProvider.FieldInfo

businessQueryConfigurer - an interface for building and applying business-specific query configurations to a single index