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
protected static int	EVENTLOG_ENTRY_FLUSH_COUNT
protected static String	EVENTLOG_ID_PRAFIX
static String	EVENTLOG_TYPE_ADD
static String	EVENTLOG_TYPE_REMOVE

Constructor Summary

Constructors

Constructor and Description
LuceneUpdateService()

Method Summary

Modifier and Type	Method and Description
boolean	flushEventLog(int junkSize) Flush the EventLog cache.
ItemCollection	getConfiguration() Returns the Lucene configuration
void	removeDocument(String uniqueID) This method adds a new eventLogEntry for a document to be deleted from the index.
void	updateDocument(ItemCollection documentContext) This method adds a single document into the to the Lucene index.
void	updateDocuments(Collection<ItemCollection> documents) This method adds a collection of documents to the Lucene index.
void	updateDocumentsUncommitted(Collection<ItemCollection> documents) This method adds a collection of documents to the Lucene index.

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

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

EVENTLOG_TYPE_ADD

public static final String EVENTLOG_TYPE_ADD

See Also:

Constant Field Values

EVENTLOG_TYPE_REMOVE

public static final String EVENTLOG_TYPE_REMOVE

See Also:

Constant Field Values

EVENTLOG_ID_PRAFIX

protected static final String EVENTLOG_ID_PRAFIX

See Also:

Constant Field Values

EVENTLOG_ENTRY_FLUSH_COUNT

protected static final int EVENTLOG_ENTRY_FLUSH_COUNT

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 to the Lucene index. Before the document is added to the index, a new eventLogEntry is created. The document will be indexed after the method flushEventLog is called. This method is called by the LuceneSearchService finder methods.

The method supports committed read. This means that a running transaction will not read an uncommitted document from the Lucene index.

Parameters:

documentContext -

updateDocuments

public void updateDocuments(Collection<ItemCollection> documents)

This method adds a collection of documents to the Lucene index. For each document in a given selection a new eventLogEntry is created. The documents will be indexed after the method flushEventLog is called. This method is called by the LuceneSearchService finder methods.

The method supports committed read. This means that a running transaction will not read uncommitted documents from the Lucene index.

Parameters:

documents - to be indexed

Throws:

IndexException

See Also:

updateDocumentsUncommitted

updateDocumentsUncommitted

public void updateDocumentsUncommitted(Collection<ItemCollection> documents)

This method adds a collection of documents to the Lucene index. The documents are added immediately to the index. Calling this method within a running transaction leads to a uncommitted reads in the index. For transaction control, it is recommended to use instead the the method updateDocumetns() which takes care of uncommitted reads.

This method is used by the JobHandlerRebuildIndex only.

Parameters:

documents - of ItemCollections to be indexed

Throws:

IndexException

removeDocument

public void removeDocument(String uniqueID)

This method adds a new eventLogEntry for a document to be deleted from the index. The document will be removed from the index after the method fluschEventLog is called. This method is called by the LuceneSearchService finder method only.

Parameters:

uniqueID - of the workitem to be removed

Throws:

PluginException

flushEventLog

public boolean flushEventLog(int junkSize)

Flush the EventLog cache. This method is called by the LuceneSerachServicen only.

The method flushes the cache in smaller blocks of the given junkSize. to avoid a heap size problem. The default flush size is 16. The eventLog cache is tracked by the flag 'dirtyIndex'.

issue #439 - The method returns false if the event log contains more entries as defined by the given JunkSize. In this case the caller should recall the method which runs always in a new transaction. The goal of this mechanism is to reduce the event log even in cases the outer transaction breaks.

Returns:

true if the the complete event log was flushed. If false the method must be recalled.

See Also:

LuceneSearchService