Package io.jmix.searchopensearch.searching.strategy

Class OpenSearchSearchStrategyProvider

java.lang.Object

io.jmix.searchopensearch.searching.strategy.OpenSearchSearchStrategyProvider

All Implemented Interfaces:

SearchStrategyProvider<OpenSearchSearchStrategy>

public class OpenSearchSearchStrategyProvider
extends Object
implements SearchStrategyProvider<OpenSearchSearchStrategy>

Provides OpenSearch search strategies

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	defaultStrategyName
protected final Map<String,OpenSearchSearchStrategy>	registry

Constructor Summary

Constructors

Constructor	Description
OpenSearchSearchStrategyProvider(Collection<OpenSearchSearchStrategy> searchStrategies, SearchProperties applicationProperties)

Method Summary

Modifier and Type	Method	Description
OpenSearchSearchStrategy	findSearchStrategyByName(String strategyName)	Returns a OpenSearchSearchStrategy by provided name.
Collection<OpenSearchSearchStrategy>	getAllSearchStrategies()	Returns all registered search strategies.
OpenSearchSearchStrategy	getDefaultSearchStrategy()	Gets default search strategy.
OpenSearchSearchStrategy	getSearchStrategyByName(String strategyName)	Gets OpenSearchSearchStrategy by provided name.

Methods inherited from class java.lang.Object

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

Field Details

registry

protected final Map<String,OpenSearchSearchStrategy> registry

defaultStrategyName

protected final String defaultStrategyName

Constructor Details

OpenSearchSearchStrategyProvider

public OpenSearchSearchStrategyProvider(Collection<OpenSearchSearchStrategy> searchStrategies,
 SearchProperties applicationProperties)

Method Details

getSearchStrategyByName

public OpenSearchSearchStrategy getSearchStrategyByName(String strategyName)

Gets OpenSearchSearchStrategy by provided name. Throws exception if there is no strategy with such name.

Specified by:

getSearchStrategyByName in interface SearchStrategyProvider<OpenSearchSearchStrategy>

Parameters:

strategyName - strategy name

Returns:

OpenSearchSearchStrategy

Throws:

IllegalStateException - if strategy with provided name not found

getDefaultSearchStrategy

public OpenSearchSearchStrategy getDefaultSearchStrategy()

Gets default search strategy.

Specified by:

getDefaultSearchStrategy in interface SearchStrategyProvider<OpenSearchSearchStrategy>

Returns:

OpenSearchSearchStrategy

getAllSearchStrategies

public Collection<OpenSearchSearchStrategy> getAllSearchStrategies()

Returns all registered search strategies.

Specified by:

getAllSearchStrategies in interface SearchStrategyProvider<OpenSearchSearchStrategy>

Returns:

all OpenSearchSearchStrategy

findSearchStrategyByName

@Nullable
public OpenSearchSearchStrategy findSearchStrategyByName(String strategyName)

Returns a OpenSearchSearchStrategy by provided name. Returns null if there is no strategy with such name.

Specified by:

findSearchStrategyByName in interface SearchStrategyProvider<OpenSearchSearchStrategy>

Parameters:

strategyName - strategy name

Returns:

OpenSearchSearchStrategy or null if no strategy was found