Package ch.tocco.nice2.enterprisesearch.impl.elasticsearch

Class ElasticSearchFulltextIndexService

java.lang.Object

ch.tocco.nice2.enterprisesearch.impl.AbstractFulltextIndexService<Void>

ch.tocco.nice2.enterprisesearch.impl.elasticsearch.ElasticSearchFulltextIndexService

All Implemented Interfaces:

FulltextIndexService

@Component
@ConditionalOnProperty(name="nice2.enterprisesearch.elasticsearch.hostName")
public class ElasticSearchFulltextIndexService
extends AbstractFulltextIndexService<Void>

Field Summary

Fields inherited from class ch.tocco.nice2.enterprisesearch.impl.AbstractFulltextIndexService

businessUnitManager, commandExecutor, context, dataModel, dataSource, defaultDisplayService, exclusiveOperationInProgress, extractors, localeResolverService, logger, moduleManager, pageLoaderPartitionSize, persistenceService, queryBuilderFactory, queryProcessorService, securityManager, taskSchedulingService, textResources, typeManager

Constructor Summary

Constructors

Constructor

Description

ElasticSearchFulltextIndexService(DataModel dataModel, Context context, PersistenceService persistenceService, QueryProcessorService queryProcessorService, DefaultDisplayService defaultDisplayService, BusinessUnitManager businessUnitManager, QueryBuilderFactory queryBuilderFactory, SecurityManager securityManager, LocaleResolverService localeResolverService, TaskSchedulingService taskSchedulingService, DataSource dataSource, TextResources textResources, TypeManager typeManager, org.slf4j.Logger logger, CommandExecutor commandExecutor, ModuleManager moduleManager)

Method Summary

Modifier and Type	Method	Description
protected void	deleteByEntityModel(EntityModel entityModel)
void	deleteByIds(List<String> ids)
protected void	deleteByQuery(FulltextSearchQuery fulltextSearchQuery)
protected void	doAddEntity(Entity entity)
protected void	doDeleteEntity(EntityId entityId)
protected void	doUpdateEntity(Entity entity)
List<String>	fetchSuggestions(String queryString)	Runs a suggestion query against the index with the specified query string.
protected void	handleIndexingForEntity(EntityList entityList)
protected FulltextSearchResponseImpl	handleQuery(FulltextSearchQuery fulltextSearchQuery)
void	init()
protected FulltextSearchQuery	setIndexFixPagingParams(FulltextSearchQuery fulltextSearchQuery, int limit, PagedLoader.StartParam<FulltextSearchResponse.Document> startParam)	Override this method to set different paging params than limit and offset (e.g.
void	setSearchFields(String searchFields)
void	setupIndex()	Setup mapping in a new index
void	truncateIndex()	Truncates (remove all records) the whole index.

Methods inherited from class ch.tocco.nice2.enterprisesearch.impl.AbstractFulltextIndexService

addEntity, checkForUnusedEntries, checkIndexForEntity, deleteEntity, deleteUnusedEntries, filterEntityTypes, fixIndex, fixIndexForEntity, getExtractorResult, getIndexPriority, handleSecurity, isIndexed, prepareQuery, query, runAsAnonymous, runCompleteIndexCheck, runCompleteIndexing, runIndexingForEntity, setExtractors, updateEntity, wasTaskRun

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticSearchFulltextIndexService

public ElasticSearchFulltextIndexService(DataModel dataModel,
 Context context,
 PersistenceService persistenceService,
 QueryProcessorService queryProcessorService,
 DefaultDisplayService defaultDisplayService,
 BusinessUnitManager businessUnitManager,
 QueryBuilderFactory queryBuilderFactory,
 SecurityManager securityManager,
 LocaleResolverService localeResolverService,
 TaskSchedulingService taskSchedulingService,
 DataSource dataSource,
 TextResources textResources,
 TypeManager typeManager,
 org.slf4j.Logger logger,
 CommandExecutor commandExecutor,
 ModuleManager moduleManager)

Method Details

init

@PostConstruct
public void init()

setSearchFields

@Value("${nice2.enterprisesearch.elasticsearch.searchFields}")
public void setSearchFields(String searchFields)

setupIndex

public void setupIndex()

Description copied from interface: FulltextIndexService

Setup mapping in a new index

handleIndexingForEntity

protected void handleIndexingForEntity(EntityList entityList)

Specified by:

handleIndexingForEntity in class AbstractFulltextIndexService<Void>

truncateIndex

public void truncateIndex()

Description copied from interface: FulltextIndexService

Truncates (remove all records) the whole index. USE WITH CARE! This method can only be executed once per instance.

doAddEntity

protected void doAddEntity(Entity entity)

Specified by:

doAddEntity in class AbstractFulltextIndexService<Void>

doUpdateEntity

protected void doUpdateEntity(Entity entity)

Specified by:

doUpdateEntity in class AbstractFulltextIndexService<Void>

doDeleteEntity

protected void doDeleteEntity(EntityId entityId)

Specified by:

doDeleteEntity in class AbstractFulltextIndexService<Void>

deleteByEntityModel

protected void deleteByEntityModel(EntityModel entityModel)

Specified by:

deleteByEntityModel in class AbstractFulltextIndexService<Void>

setIndexFixPagingParams

protected FulltextSearchQuery setIndexFixPagingParams(FulltextSearchQuery fulltextSearchQuery,
 int limit,
 PagedLoader.StartParam<FulltextSearchResponse.Document> startParam)

Description copied from class: AbstractFulltextIndexService

Override this method to set different paging params than limit and offset (e.g. `#searchAfter()`)

Overrides:

setIndexFixPagingParams in class AbstractFulltextIndexService<Void>

handleQuery

protected FulltextSearchResponseImpl handleQuery(FulltextSearchQuery fulltextSearchQuery)

Specified by:

handleQuery in class AbstractFulltextIndexService<Void>

deleteByQuery

protected void deleteByQuery(FulltextSearchQuery fulltextSearchQuery)

Specified by:

deleteByQuery in class AbstractFulltextIndexService<Void>

deleteByIds

public void deleteByIds(List<String> ids)

Specified by:

deleteByIds in class AbstractFulltextIndexService<Void>

fetchSuggestions

public List<String> fetchSuggestions(String queryString)

Description copied from interface: FulltextIndexService

Runs a suggestion query against the index with the specified query string.

Parameters:

queryString - any query string in lucene syntax

Returns:

a list of strings with suggestions