Package io.jmix.search.searching

Class AbstractSearchQueryConfigurer<RB,QB,OB>

java.lang.Object

io.jmix.search.searching.AbstractSearchQueryConfigurer<RB,QB,OB>

Type Parameters:

RB - a platform-specific SearchRequestBuilder type

QB - a platform-specific QueryBuilder type

OB - a platform-specific ObjectBuilder type

All Implemented Interfaces:

SearchQueryConfigurer<RB,QB,OB>

Direct Known Subclasses:

ElasticSearchQueryConfigurer, OpenSearchQueryConfigurer

public abstract class AbstractSearchQueryConfigurer<RB,QB,OB>
extends Object
implements SearchQueryConfigurer<RB,QB,OB>

Implements common logic for all platform-specific implementations. Contains "out of the box" SubfieldsProvider-s for the typical cases.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.search.searching.SearchQueryConfigurer

SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB>

Field Summary

Fields

Modifier and Type	Field	Description
static final VirtualSubfieldsProvider	NO_VIRTUAL_SUBFIELDS
protected final SearchRequestScopeProvider	searchRequestScopeProvider
static final VirtualSubfieldsProvider	WITH_PREFIX_VIRTUAL_SUBFIELDS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSearchQueryConfigurer(SearchRequestScopeProvider searchRequestScopeProvider)

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.
protected OB	createQuery(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer, List<IndexSearchRequestScope> indexSearchRequestScopes)
protected abstract OB	createQueryForMultipleIndexes(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer, List<IndexSearchRequestScope> indexSearchRequestScopes)
protected abstract OB	createQueryForSingleIndex(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer, IndexSearchRequestScope indexSearchRequestScope)
protected abstract void	querySettingToRequestBuilder(SearchRequestContext<RB> requestContext, SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer, List<IndexSearchRequestScope> indexSearchRequestScopes)	Configures the search request by applying query settings using the provided request context, business query configurer, and index search request scopes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_VIRTUAL_SUBFIELDS

public static final VirtualSubfieldsProvider NO_VIRTUAL_SUBFIELDS

WITH_PREFIX_VIRTUAL_SUBFIELDS

public static final VirtualSubfieldsProvider WITH_PREFIX_VIRTUAL_SUBFIELDS

searchRequestScopeProvider

protected final SearchRequestScopeProvider searchRequestScopeProvider

Constructor Details

AbstractSearchQueryConfigurer

protected AbstractSearchQueryConfigurer(SearchRequestScopeProvider searchRequestScopeProvider)

Method Details

configureRequest

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

Description copied from interface: SearchQueryConfigurer

Configures request for the data querying from the search server.

Specified by:

configureRequest in interface SearchQueryConfigurer<RB,QB,OB>

Parameters:

requestContext - a request context for the request building.

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

configureRequest

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

Description copied from interface: SearchQueryConfigurer

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

Specified by:

configureRequest in interface SearchQueryConfigurer<RB,QB,OB>

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.

querySettingToRequestBuilder

protected abstract void querySettingToRequestBuilder(SearchRequestContext<RB> requestContext,
 SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer,
 List<IndexSearchRequestScope> indexSearchRequestScopes)

Configures the search request by applying query settings using the provided request context, business query configurer, and index search request scopes.

Parameters:

requestContext - the container holding the request building information and platform-specific request builder

businessQueryConfigurer - the configurer used for building queries for given index search scopes

indexSearchRequestScopes - a list of search request scopes representing the targeted indexes and their configurations

createQuery

protected OB createQuery(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer,
 List<IndexSearchRequestScope> indexSearchRequestScopes)

createQueryForSingleIndex

protected abstract OB createQueryForSingleIndex(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer,
 IndexSearchRequestScope indexSearchRequestScope)

createQueryForMultipleIndexes

protected abstract OB createQueryForMultipleIndexes(SearchQueryConfigurer.BusinessQueryConfigurer<QB,OB> businessQueryConfigurer,
 List<IndexSearchRequestScope> indexSearchRequestScopes)