Package org.silverpeas.core.index.indexing.model

Class IndexerTask

java.lang.Object

org.silverpeas.core.thread.task.AbstractRequestTask<org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext>

org.silverpeas.core.index.indexing.model.IndexerTask

All Implemented Interfaces:

Callable<Void>

@Technical
@Bean
public class IndexerTask
extends AbstractRequestTask<org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext>

This task is in charge of processing indexation requests.

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.thread.task.AbstractRequestTask

AbstractRequestTask.ProcessContext, AbstractRequestTask.Request<C>

Constructor Summary

Constructors

Constructor	Description
IndexerTask()

Method Summary

Modifier and Type	Method	Description
static void	addIndexEntry(FullIndexEntry indexEntry)	Add a request 'add entry index'.
protected void	afterNoMoreRequest()	Invoked when it does not exist AbstractRequestTask.Request to process anymore.
protected org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext	getProcessContext()	Gets the context given for each request to process.
protected int	getRequestQueueLimit()
static void	removeAllIndexEntries()	Add a request 'remove all index entries'.
static void	removeIndexEntriesByScope(String scope)	Add a request 'remove index entries by scope'.
static void	removeIndexEntry(IndexEntryKey indexEntry)	Add a request 'remove entry index'.

Methods inherited from class org.silverpeas.core.thread.task.AbstractRequestTask

call, processRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexerTask

public IndexerTask()

Method Detail

addIndexEntry

public static void addIndexEntry(FullIndexEntry indexEntry)

Add a request 'add entry index'.

Parameters:

indexEntry - the index entry ro process.

removeIndexEntry

public static void removeIndexEntry(IndexEntryKey indexEntry)

Add a request 'remove entry index'.

Parameters:

indexEntry - the index entry ro process.

removeIndexEntriesByScope

public static void removeIndexEntriesByScope(String scope)

Add a request 'remove index entries by scope'.

Parameters:

scope - the scope of index entries to process.

removeAllIndexEntries

public static void removeAllIndexEntries()

Add a request 'remove all index entries'.

getRequestQueueLimit

protected int getRequestQueueLimit()

Overrides:

getRequestQueueLimit in class AbstractRequestTask<org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext>

Returns:

0 indicates no limit, value greater than 0 will block the threads pushing new request if the limit is reached until there is again possibility to push.

afterNoMoreRequest

protected void afterNoMoreRequest()

Description copied from class: AbstractRequestTask

Invoked when it does not exist AbstractRequestTask.Request to process anymore. Is is called in any case, even if a severe error has been thrown.

Overrides:

afterNoMoreRequest in class AbstractRequestTask<org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext>

getProcessContext

protected org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext getProcessContext()

Description copied from class: AbstractRequestTask

Gets the context given for each request to process.

Overrides:

getProcessContext in class AbstractRequestTask<org.silverpeas.core.index.indexing.model.IndexerTask.IndexerProcessContext>

Returns:

the instance of process context.