Package io.jmix.search.searching

Interface SearchQueryConfigurer<RB,QB,OB>

Type Parameters:

RB - a platform-specific SearchRequestBuilder type

QB - a platform-specific QueryBuilder type

OB - a platform-specific ObjectBuilder type

All Known Implementing Classes:

AbstractSearchQueryConfigurer, ElasticSearchQueryConfigurer, OpenSearchQueryConfigurer

public interface SearchQueryConfigurer<RB,QB,OB>

An interface for implementing common logic for the search request configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB>	A common interface for query building for the single index.

Method Summary

Modifier and Type	Method	Description
void	configureRequest(SearchRequestContext<RB> requestContext, SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer)	Configures request for the data querying from the search server.
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 request for the data querying from the search server.

Parameters:

requestContext - a request context for the request building.

businessQueryConfigurer - a builder that builds query for the 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 - a request context for the request building.

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

businessQueryConfigurer - a builder that builds query for the single index.