org.imixs.workflow.engine.lucene

Class LuceneIndexService

java.lang.Object

org.imixs.workflow.engine.lucene.LuceneIndexService

public class LuceneIndexService
extends Object

This session ejb provides functionality to maintain a local Lucene index.

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS
static String	DEFAULT_ANALYZER
static String	DEFAULT_INDEX_DIRECTORY
static int	EVENTLOG_ENTRY_FLUSH_COUNT

Constructor Summary

Constructors

Constructor and Description
LuceneIndexService()

Method Summary

Modifier and Type	Method and Description
protected void	addItemValues(org.apache.lucene.document.Document doc, ItemCollection workitem, String _itemName, boolean analyzeValue, boolean store) adds a field value into a Lucene document.
protected org.apache.lucene.document.Document	createDocument(ItemCollection aworkitem) This method creates a lucene document based on a ItemCollection.
protected org.apache.lucene.index.IndexWriter	createIndexWriter() This method creates a new instance of a lucene IndexWriter.
boolean	flushEventLog(int junkSize) Flush the EventLog cache.
protected boolean	flushEventLogByCount(int count) This method flushes a given count of eventLogEntries.
String	getLuceneAnalyzerClass()
String	getLuceneIndexDir()
void	indexDocuments(Collection<ItemCollection> documents) This method adds a collection of documents to the Lucene index.
void	rebuildIndex(org.apache.lucene.store.Directory indexDir) This method forces an update of the full text index.
void	setLuceneAnalyzerClass(String luceneAnalyzerClass)
void	setLuceneIndexDir(String luceneIndexDir)

Methods inherited from class java.lang.Object

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

Field Detail

EVENTLOG_ENTRY_FLUSH_COUNT

public static final int EVENTLOG_ENTRY_FLUSH_COUNT

See Also:

Constant Field Values

ANONYMOUS

public static final String ANONYMOUS

See Also:

Constant Field Values

DEFAULT_ANALYZER

public static final String DEFAULT_ANALYZER

See Also:

Constant Field Values

DEFAULT_INDEX_DIRECTORY

public static final String DEFAULT_INDEX_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

LuceneIndexService

public LuceneIndexService()

Method Detail

getLuceneIndexDir

public String getLuceneIndexDir()

setLuceneIndexDir

public void setLuceneIndexDir(String luceneIndexDir)

getLuceneAnalyzerClass

public String getLuceneAnalyzerClass()

setLuceneAnalyzerClass

public void setLuceneAnalyzerClass(String luceneAnalyzerClass)

flushEventLog

public boolean flushEventLog(int junkSize)

Flush the EventLog cache. This method is called by the LuceneSerachService 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

rebuildIndex

public void rebuildIndex(org.apache.lucene.store.Directory indexDir)
                  throws IOException

This method forces an update of the full text index. The method also creates the index directory if it does not yet exist.

Throws:

IOException

indexDocuments

public void indexDocuments(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

flushEventLogByCount

protected boolean flushEventLogByCount(int count)

This method flushes a given count of eventLogEntries. The method return true if no more eventLogEntries exist.

Parameters:

count - the max size of a eventLog engries to remove.

Returns:

true if the cache was totally flushed.

createDocument

protected org.apache.lucene.document.Document createDocument(ItemCollection aworkitem)

This method creates a lucene document based on a ItemCollection. The Method creates for each field specified in the FieldList a separate index field for the lucene document. The property 'AnalyzeIndexFields' defines if a indexfield value should by analyzed by the Lucene Analyzer (default=false)

Parameters:

aworkitem -

Returns:

addItemValues

protected void addItemValues(org.apache.lucene.document.Document doc,
                             ItemCollection workitem,
                             String _itemName,
                             boolean analyzeValue,
                             boolean store)

adds a field value into a Lucene document. The parameter store specifies if the value will become part of the Lucene document which is optional.

Parameters:

doc - an existing lucene document

workitem - the workitem containg the values

itemName - the Fieldname inside the workitem

analyzeValue - indicates if the value should be parsed by the analyzer

store - indicates if the value will become part of the Lucene document

createIndexWriter

protected org.apache.lucene.index.IndexWriter createIndexWriter()
                                                         throws IOException

This method creates a new instance of a lucene IndexWriter. The location of the lucene index in the filesystem is read from the imixs.properties

Returns:

Throws:

IOException