org.imixs.workflow.engine.lucene

Class LuceneUpdateService

java.lang.Object

org.imixs.workflow.engine.lucene.LuceneUpdateService

public class LuceneUpdateService
extends Object

The LuceneUpdateService provides methods to write Imixs Workitems into a Lucene search index. With the method addWorkitem() a ItemCollection can be added to a lucene search index. The service init method reads the property file 'imixs.properties' from the current classpath to determine the configuration.

• The property "IndexDir" defines the location of the lucene index
• The property "FulltextFieldList" lists all fields which should be searchable after a workitem was updated
• The property "IndexFieldList" lists all fields which should be indexed as keywords by the lucene search engine

The singleton pattern is used to avoid conflicts within multi-thread scenarios. The service is used by the LucenPlugin to update the lucene index during a workflow processing step.

Version:

1.2

Author:

rsoika

See Also:

did-not-update-the-index-when-called-from-a-web-modul, LucenePlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANONYMOUS
protected static String	DEFAULT_ANALYSER
protected static String	DEFAULT_INDEX_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
LuceneUpdateService()

Method Summary

Modifier and Type	Method and Description
ItemCollection	getConfiguration() Returns the Lucene configuration
void	removeDocument(String uniqueID) This method removes a single Document from the search index.
void	updateDocument(ItemCollection documentContext) This method adds a single document into the search index.
void	updateDocuments(Collection<ItemCollection> documents) This method updates the search index for a collection of Documents.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANALYSER

protected static final String DEFAULT_ANALYSER

See Also:

Constant Field Values

DEFAULT_INDEX_DIRECTORY

protected static final String DEFAULT_INDEX_DIRECTORY

See Also:

Constant Field Values

ANONYMOUS

protected static final String ANONYMOUS

See Also:

Constant Field Values

Constructor Detail

LuceneUpdateService

public LuceneUpdateService()

Method Detail

getConfiguration

public ItemCollection getConfiguration()

Returns the Lucene configuration

Returns:

updateDocument

public void updateDocument(ItemCollection documentContext)

This method adds a single document into the search index.

Parameters:

documentContext -

updateDocuments

public void updateDocuments(Collection<ItemCollection> documents)

This method updates the search index for a collection of Documents.

Parameters:

documents - of ItemCollections to be indexed

Throws:

IndexException

removeDocument

public void removeDocument(String uniqueID)

This method removes a single Document from the search index.

Parameters:

uniqueID - of the workitem to be removed

Throws:

PluginException