Package io.jmix.searchopensearch.searching.strategy.impl

Class StartsWithOpenSearchSearchStrategy

java.lang.Object

io.jmix.search.searching.impl.AbstractSearchStrategy

io.jmix.searchopensearch.searching.strategy.impl.StartsWithOpenSearchSearchStrategy

All Implemented Interfaces:

SearchStrategy, OpenSearchSearchStrategy

@Component("search_StartsWithOpenSearchSearchStrategy")
public class StartsWithOpenSearchSearchStrategy
extends AbstractSearchStrategy
implements OpenSearchSearchStrategy

Class that encapsulates logic of SearchStrategy that searches documents by prefix.

Field Summary

Fields

Modifier and Type	Field	Description
protected final IndexConfigurationManager	indexConfigurationManager
protected final Metadata	metadata
protected final PolicyStore	policyStore
protected final SearchProperties	searchProperties
protected final SearchUtils	searchUtils
protected final SecureOperations	secureOperations

Constructor Summary

Constructors

Constructor	Description
StartsWithOpenSearchSearchStrategy(IndexConfigurationManager indexConfigurationManager, SearchProperties searchProperties, SecureOperations secureOperations, PolicyStore policyStore, Metadata metadata, SearchUtils searchUtils)

Method Summary

Modifier and Type	Method	Description
void	configureRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder, SearchContext searchContext)	Configures OpenSearch SearchRequest.
protected void	configureTermsQuery(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder, SearchContext searchContext)
protected void	configureWildcardQuery(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder, SearchContext searchContext, Set<String> effectiveFieldsToSearch)
String	getName()	Provides the name of this search strategy.
protected boolean	isSearchTermExceedMaxPrefixSize(String searchText, int maxPrefixSize)

Methods inherited from class io.jmix.search.searching.impl.AbstractSearchStrategy

toString

Methods inherited from class java.lang.Object

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

Field Details

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

searchProperties

protected final SearchProperties searchProperties

secureOperations

protected final SecureOperations secureOperations

policyStore

protected final PolicyStore policyStore

metadata

protected final Metadata metadata

searchUtils

protected final SearchUtils searchUtils

Constructor Details

StartsWithOpenSearchSearchStrategy

public StartsWithOpenSearchSearchStrategy(IndexConfigurationManager indexConfigurationManager,
 SearchProperties searchProperties,
 SecureOperations secureOperations,
 PolicyStore policyStore,
 Metadata metadata,
 SearchUtils searchUtils)

Method Details

getName

public String getName()

Description copied from interface: SearchStrategy

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

Specified by:

getName in interface SearchStrategy

Returns:

name

configureRequest

public void configureRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder,
 SearchContext searchContext)

Description copied from interface: OpenSearchSearchStrategy

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.

Specified by:

configureRequest in interface OpenSearchSearchStrategy

Parameters:

requestBuilder - allows to configure search request

searchContext - contains details about search being performed

configureTermsQuery

protected void configureTermsQuery(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder,
 SearchContext searchContext)

configureWildcardQuery

protected void configureWildcardQuery(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder,
 SearchContext searchContext,
 Set<String> effectiveFieldsToSearch)

isSearchTermExceedMaxPrefixSize

protected boolean isSearchTermExceedMaxPrefixSize(String searchText,
 int maxPrefixSize)