Package ch.tocco.nice2.enterprisesearch.impl

Class AbstractFulltextIndexService<T>

java.lang.Object

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

All Implemented Interfaces:

FulltextIndexService

Direct Known Subclasses:

ElasticSearchFulltextIndexService, FakeFulltextIndexService

public abstract class AbstractFulltextIndexService<T>
extends Object
implements FulltextIndexService

This abstract class contains all generic code which could use any enterprise search system.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BusinessUnitManager	businessUnitManager
protected final CommandExecutor	commandExecutor
protected final Context	context
protected final DataModel	dataModel
protected final DataSource	dataSource
protected final DefaultDisplayService	defaultDisplayService
protected boolean	exclusiveOperationInProgress
protected List<IndexExtractor>	extractors
protected final LocaleResolverService	localeResolverService
protected final org.slf4j.Logger	logger
protected final ModuleManager	moduleManager
protected int	pageLoaderPartitionSize
protected final PersistenceService	persistenceService
protected final QueryBuilderFactory	queryBuilderFactory
protected final QueryProcessorService	queryProcessorService
protected final SecurityManager	securityManager
protected final TaskSchedulingService	taskSchedulingService
protected final TextResources	textResources
protected final TypeManager	typeManager

Constructor Summary

Constructors

Constructor

Description

AbstractFulltextIndexService(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
final void	addEntity(Entity entity)	Adds the specified entity to the index.
boolean	checkForUnusedEntries(List<EntityModel> models)
final boolean	checkIndexForEntity(String entityModelName)	Check the index for the specified entity model.
protected abstract void	deleteByEntityModel(EntityModel entityModel)
protected abstract void	deleteByIds(List<String> ids)
protected abstract void	deleteByQuery(FulltextSearchQuery fulltextSearchQuery)
final void	deleteEntity(EntityId entityId)	Removes the specified entity from the index.
void	deleteUnusedEntries(List<EntityModel> models)
protected abstract void	doAddEntity(Entity entity)
protected abstract void	doDeleteEntity(EntityId entityId)
protected abstract void	doUpdateEntity(Entity entity)
protected FulltextSearchResponseImpl	filterEntityTypes(FulltextSearchResponseImpl fulltextSearchResponse)
final void	fixIndex()
void	fixIndexForEntity(String entityModelName)
protected Map<String,Object>	getExtractorResult(Entity entity)
protected int	getIndexPriority(EntityModel entityModel)
protected abstract void	handleIndexingForEntity(EntityList entityList)
protected abstract FulltextSearchResponseImpl	handleQuery(FulltextSearchQuery fulltextSearchQuery)
protected FulltextSearchResponseImpl	handleSecurity(FulltextSearchQuery fulltextSearchQuery, FulltextSearchResponseImpl fulltextSearchResponse)
protected boolean	isIndexed(EntityModel entityModel)
protected FulltextSearchQuery	prepareQuery(FulltextSearchQuery fulltextSearchQuery)
final FulltextSearchResponse	query(FulltextSearchQuery fulltextSearchQuery)	Query the index with the specified fulltext search query.
protected <T> T	runAsAnonymous(Callable<T> callable)	Executes a callable with anonymous principal.
final void	runCompleteIndexCheck()	Check the whole index.
final void	runCompleteIndexing()	Do a complete indexing of the whole database.
final void	runIndexingForEntity(String entityModelName)	Do indexing of the specified entity model.
void	setExtractors(List<IndexExtractor> indexExtractors)
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.
final void	updateEntity(Entity entity)	Updates the specified entity to the index.
boolean	wasTaskRun(String taskName)	returns true if the task already ran for the current revision

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.enterprisesearch.api.FulltextIndexService

fetchSuggestions, setupIndex, truncateIndex

Field Details

dataModel

protected final DataModel dataModel

context

protected final Context context

persistenceService

protected final PersistenceService persistenceService

queryProcessorService

protected final QueryProcessorService queryProcessorService

defaultDisplayService

protected final DefaultDisplayService defaultDisplayService

businessUnitManager

protected final BusinessUnitManager businessUnitManager

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

securityManager

protected final SecurityManager securityManager

localeResolverService

protected final LocaleResolverService localeResolverService

taskSchedulingService

protected final TaskSchedulingService taskSchedulingService

dataSource

protected final DataSource dataSource

textResources

protected final TextResources textResources

typeManager

protected final TypeManager typeManager

logger

protected final org.slf4j.Logger logger

commandExecutor

protected final CommandExecutor commandExecutor

moduleManager

protected final ModuleManager moduleManager

extractors

protected List<IndexExtractor> extractors

exclusiveOperationInProgress

protected volatile boolean exclusiveOperationInProgress

pageLoaderPartitionSize

@VisibleForTesting
@Value("${nice2.enterprisesearch.indexfix.queryPartitionSize}")
protected int pageLoaderPartitionSize

Constructor Details

AbstractFulltextIndexService

public AbstractFulltextIndexService(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

setExtractors

@Autowired
public void setExtractors(List<IndexExtractor> indexExtractors)

addEntity

public final void addEntity(Entity entity)

Description copied from interface: FulltextIndexService

Adds the specified entity to the index. This is / should used only internally by updating listener.

Specified by:

addEntity in interface FulltextIndexService

Parameters:

entity - a entity to do the specified operation with

doAddEntity

protected abstract void doAddEntity(Entity entity)

updateEntity

public final void updateEntity(Entity entity)

Description copied from interface: FulltextIndexService

Updates the specified entity to the index. This is / should used only internally by updating listener.

Specified by:

updateEntity in interface FulltextIndexService

Parameters:

entity - a entity to do the specified operation with

doUpdateEntity

protected abstract void doUpdateEntity(Entity entity)

deleteEntity

public final void deleteEntity(EntityId entityId)

Description copied from interface: FulltextIndexService

Removes the specified entity from the index. This is / should used only internally by updating listener.

Specified by:

deleteEntity in interface FulltextIndexService

Parameters:

entityId - an entity-id to do the specified operation with

doDeleteEntity

protected abstract void doDeleteEntity(EntityId entityId)

runCompleteIndexing

public final void runCompleteIndexing()

Description copied from interface: FulltextIndexService

Do a complete indexing of the whole database. It iterates over all entity types and starts with the ones with the highest indexing-priority. Entity types with indexing-priority of -1 are not included. This method can only be executed once per instance.

Specified by:

runCompleteIndexing in interface FulltextIndexService

See Also:

• FulltextIndexService.runIndexingForEntity(String)

deleteByEntityModel

protected abstract void deleteByEntityModel(EntityModel entityModel)

runIndexingForEntity

public final void runIndexingForEntity(String entityModelName)

Description copied from interface: FulltextIndexService

Do indexing of the specified entity model.

Specified by:

runIndexingForEntity in interface FulltextIndexService

Parameters:

entityModelName - a valid entity model name

See Also:

• FulltextIndexService.runCompleteIndexing()

runCompleteIndexCheck

public final void runCompleteIndexCheck()

Description copied from interface: FulltextIndexService

Check the whole index. It checks first if the count of a entity model matches (database vs. index) and the checks the version of each record. This method can only be executed once per instance.

Specified by:

runCompleteIndexCheck in interface FulltextIndexService

See Also:

• FulltextIndexService.checkIndexForEntity(String)

checkIndexForEntity

public final boolean checkIndexForEntity(String entityModelName)

Description copied from interface: FulltextIndexService

Check the index for the specified entity model.

Specified by:

checkIndexForEntity in interface FulltextIndexService

Parameters:

entityModelName - a valid entity model name

See Also:

• FulltextIndexService.runCompleteIndexCheck()

checkForUnusedEntries

public boolean checkForUnusedEntries(List<EntityModel> models)

deleteUnusedEntries

public void deleteUnusedEntries(List<EntityModel> models)

fixIndex

public final void fixIndex()

Specified by:

fixIndex in interface FulltextIndexService

fixIndexForEntity

public void fixIndexForEntity(String entityModelName)

setIndexFixPagingParams

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. `#searchAfter()`)

wasTaskRun

public boolean wasTaskRun(String taskName)

Description copied from interface: FulltextIndexService

returns true if the task already ran for the current revision

Specified by:

wasTaskRun in interface FulltextIndexService

query

public final FulltextSearchResponse query(FulltextSearchQuery fulltextSearchQuery)

Description copied from interface: FulltextIndexService

Query the index with the specified fulltext search query.

Specified by:

query in interface FulltextIndexService

Parameters:

fulltextSearchQuery - a fulltext search query object

Returns:

a fulltext search response object

handleIndexingForEntity

protected abstract void handleIndexingForEntity(EntityList entityList)

handleQuery

protected abstract FulltextSearchResponseImpl handleQuery(FulltextSearchQuery fulltextSearchQuery)

deleteByQuery

protected abstract void deleteByQuery(FulltextSearchQuery fulltextSearchQuery)

deleteByIds

protected abstract void deleteByIds(List<String> ids)

prepareQuery

protected FulltextSearchQuery prepareQuery(FulltextSearchQuery fulltextSearchQuery)

filterEntityTypes

protected FulltextSearchResponseImpl filterEntityTypes(FulltextSearchResponseImpl fulltextSearchResponse)

handleSecurity

protected FulltextSearchResponseImpl handleSecurity(FulltextSearchQuery fulltextSearchQuery,
 FulltextSearchResponseImpl fulltextSearchResponse)

isIndexed

protected boolean isIndexed(EntityModel entityModel)

getIndexPriority

protected int getIndexPriority(EntityModel entityModel)

getExtractorResult

protected Map<String,Object> getExtractorResult(Entity entity)

runAsAnonymous

protected <T> T runAsAnonymous(Callable<T> callable)

Executes a callable with anonymous principal. Should be used when adding data to index. Otherwise records may contain "personalized" data (like entity marking).