Package io.jmix.searchopensearch.searching.impl

Class OpenSearchEntitySearcher

java.lang.Object

io.jmix.searchopensearch.searching.impl.OpenSearchEntitySearcher

All Implemented Interfaces:

EntitySearcher

public class OpenSearchEntitySearcher
extends Object
implements EntitySearcher

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.opensearch.client.opensearch.OpenSearchClient	client
protected static final com.fasterxml.jackson.core.type.TypeReference<Map<String,Object>>	GENERIC_MAP_TYPE_REF
protected final IdSerialization	idSerialization
protected final IndexConfigurationManager	indexConfigurationManager
protected final InstanceNameProvider	instanceNameProvider
protected final Metadata	metadata
protected final MetadataTools	metadataTools
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final PolicyStore	policyStore
protected final SearchProperties	searchProperties
protected final OpenSearchSearchStrategyProvider	searchStrategyManager
protected final DataManager	secureDataManager
protected final SecureOperations	secureOperations

Constructor Summary

Constructors

Constructor

Description

OpenSearchEntitySearcher(org.opensearch.client.opensearch.OpenSearchClient client, IndexConfigurationManager indexConfigurationManager, Metadata metadata, MetadataTools metadataTools, DataManager secureDataManager, InstanceNameProvider instanceNameProvider, SearchProperties searchProperties, IdSerialization idSerialization, SecureOperations secureOperations, PolicyStore policyStore, OpenSearchSearchStrategyProvider searchStrategyManager)

Method Summary

Modifier and Type	Method	Description
protected void	applyPostStrategyRequestSettings(org.opensearch.client.opensearch.core.SearchRequest.Builder builder, SearchContext searchContext, int offset)
protected void	configureHighlight(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder)
protected org.opensearch.client.opensearch.core.SearchRequest	createRequest(SearchContext searchContext, List<String> targetIndexes, OpenSearchSearchStrategy searchStrategy, int offset)
protected SearchResultEntry	createSearchResultEntry(String entityId, String instanceName, String entityName, org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode> searchHit)
protected void	fillSearchResult(SearchResultImpl searchResultImpl, Map<MetaClass,List<org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode>>> hitsByEntityName)
protected String	formatFieldName(String fieldName)
protected Map<MetaClass,List<org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode>>>	groupHitsByEntity(org.opensearch.client.opensearch.core.search.HitsMetadata<com.fasterxml.jackson.databind.node.ObjectNode> hits)
protected void	initRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder builder, List<String> targetIndexes)
protected SearchResultImpl	initSearchResult(SearchContext searchContext, OpenSearchSearchStrategy searchStrategy)
protected boolean	isDisplayedField(String fieldName)
protected boolean	isResultFull(SearchResultImpl searchResultImpl, SearchContext searchContext)
protected Map<String,Object>	objectNodeToMap(com.fasterxml.jackson.databind.node.ObjectNode node)
protected Set<String>	reloadIds(MetaClass metaClass, Collection<Object> entityIds)
protected OpenSearchSearchStrategy	resolveSearchStrategy(String searchStrategyName)
protected List<String>	resolveTargetIndexes(SearchContext searchContext)
SearchResult	search(SearchContext searchContext)	Performs search in search indexes according to provided SearchContext and default SearchStrategy.
SearchResult	search(SearchContext searchContext, String searchStrategyName)	Performs search in search indexes according to provided SearchContext and SearchStrategy.
SearchResult	searchNextPage(SearchResult previousSearchResult)	Performs search of next page according to SearchContext and SearchResult contained in provided SearchStrategy related to previous page.

Methods inherited from class java.lang.Object

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

Field Details

GENERIC_MAP_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Map<String,Object>> GENERIC_MAP_TYPE_REF

client

protected final org.opensearch.client.opensearch.OpenSearchClient client

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

metadata

protected final Metadata metadata

metadataTools

protected final MetadataTools metadataTools

secureDataManager

protected final DataManager secureDataManager

instanceNameProvider

protected final InstanceNameProvider instanceNameProvider

searchProperties

protected final SearchProperties searchProperties

idSerialization

protected final IdSerialization idSerialization

secureOperations

protected final SecureOperations secureOperations

policyStore

protected final PolicyStore policyStore

searchStrategyManager

protected final OpenSearchSearchStrategyProvider searchStrategyManager

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

OpenSearchEntitySearcher

public OpenSearchEntitySearcher(org.opensearch.client.opensearch.OpenSearchClient client,
 IndexConfigurationManager indexConfigurationManager,
 Metadata metadata,
 MetadataTools metadataTools,
 DataManager secureDataManager,
 InstanceNameProvider instanceNameProvider,
 SearchProperties searchProperties,
 IdSerialization idSerialization,
 SecureOperations secureOperations,
 PolicyStore policyStore,
 OpenSearchSearchStrategyProvider searchStrategyManager)

Method Details

search

public SearchResult search(SearchContext searchContext)

Description copied from interface: EntitySearcher

Performs search in search indexes according to provided SearchContext and default SearchStrategy.

See EntitySearcher.search(SearchContext, String)

Specified by:

search in interface EntitySearcher

Parameters:

searchContext - runtime settings of specific search

Returns:

SearchResult with found objects

search

public SearchResult search(SearchContext searchContext,
 String searchStrategyName)

Description copied from interface: EntitySearcher

Performs search in search indexes according to provided SearchContext and SearchStrategy.

Specified by:

search in interface EntitySearcher

Parameters:

searchContext - runtime settings of specific search

searchStrategyName - the way incoming search text should be processed

Returns:

SearchResult with found objects

searchNextPage

public SearchResult searchNextPage(SearchResult previousSearchResult)

Description copied from interface: EntitySearcher

Performs search of next page according to SearchContext and SearchResult contained in provided SearchStrategy related to previous page.

Specified by:

searchNextPage in interface EntitySearcher

Parameters:

previousSearchResult - SearchResult of previous page

Returns:

SearchResult with found objects

initSearchResult

protected SearchResultImpl initSearchResult(SearchContext searchContext,
 OpenSearchSearchStrategy searchStrategy)

resolveTargetIndexes

protected List<String> resolveTargetIndexes(SearchContext searchContext)

resolveSearchStrategy

protected OpenSearchSearchStrategy resolveSearchStrategy(String searchStrategyName)

createRequest

protected org.opensearch.client.opensearch.core.SearchRequest createRequest(SearchContext searchContext,
 List<String> targetIndexes,
 OpenSearchSearchStrategy searchStrategy,
 int offset)

initRequest

protected void initRequest(org.opensearch.client.opensearch.core.SearchRequest.Builder builder,
 List<String> targetIndexes)

applyPostStrategyRequestSettings

protected void applyPostStrategyRequestSettings(org.opensearch.client.opensearch.core.SearchRequest.Builder builder,
 SearchContext searchContext,
 int offset)

configureHighlight

protected void configureHighlight(org.opensearch.client.opensearch.core.SearchRequest.Builder requestBuilder)

groupHitsByEntity

protected Map<MetaClass,List<org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode>>> groupHitsByEntity(org.opensearch.client.opensearch.core.search.HitsMetadata<com.fasterxml.jackson.databind.node.ObjectNode> hits)

fillSearchResult

protected void fillSearchResult(SearchResultImpl searchResultImpl,
 Map<MetaClass,List<org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode>>> hitsByEntityName)

isResultFull

protected boolean isResultFull(SearchResultImpl searchResultImpl,
 SearchContext searchContext)

objectNodeToMap

@Nullable
protected Map<String,Object> objectNodeToMap(@Nullable
 com.fasterxml.jackson.databind.node.ObjectNode node)

createSearchResultEntry

protected SearchResultEntry createSearchResultEntry(String entityId,
 String instanceName,
 String entityName,
 org.opensearch.client.opensearch.core.search.Hit<com.fasterxml.jackson.databind.node.ObjectNode> searchHit)

isDisplayedField

protected boolean isDisplayedField(String fieldName)

formatFieldName

protected String formatFieldName(String fieldName)

reloadIds

protected Set<String> reloadIds(MetaClass metaClass,
 Collection<Object> entityIds)