org.imixs.workflow.plugins.jee.extended
Class LucenePlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin
      org.imixs.workflow.plugins.jee.extended.LucenePlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

public class LucenePlugin
extends AbstractPlugin

This Plugin add workitems to a lucene search index. The Plugin provides a set of static methods which can be used also outside the workflowManager to index single workitems or collections of workitems. With the method addWorkitem() a ItemCollection can be added to a lucene search index. The Plugin reads the property file 'imixs-search.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 If the plugin is used as worflow pugin in the model definition, the plugin should be run last to be sure that newly computed values like the worklfow status or the wokflowSummary are indexed correctly

  Author:

  rsoika

  Field Summary

  Fields inherited from class org.imixs.workflow.plugins.AbstractPlugin

  ctx

  Fields inherited from interface org.imixs.workflow.Plugin

  PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

  Constructor Summary

  LucenePlugin()
  

  Method Summary

  static boolean	addWorkitem(org.imixs.workflow.ItemCollection documentContext) This method adds a single workitem into the search index.
  static boolean	addWorklist(Collection<org.imixs.workflow.ItemCollection> worklist) This method adds a collection of workitems into the search index.
  void	close(int status)
  static org.apache.lucene.document.Document	createDocument(Properties prop, org.imixs.workflow.ItemCollection aworkitem) This method creates a lucene document based on a ItemCollection.
  static org.apache.lucene.search.IndexSearcher	createIndexSearcher()
  static org.apache.lucene.index.IndexWriter	createIndexWriter(Properties prop) This method creates a new instance of a lucene IndexWriter.
  void	init(org.imixs.workflow.WorkflowContext actx)
  static Properties	loadProperties() loads a imixs-search.property file
  static boolean	matchConditions(Properties prop, org.imixs.workflow.ItemCollection aworktiem) test if the workitem matches the conditions to be added into the search index.
  int	run(org.imixs.workflow.ItemCollection documentContext, org.imixs.workflow.ItemCollection activity) This method adds the current workitem to the search index by calling the method addWorkitem.
  static List<org.imixs.workflow.ItemCollection>	search(String sSearchTerm, WorkflowService workflowService) Returns a ItemCollection List matching the provided search term.

  Methods inherited from class org.imixs.workflow.plugins.AbstractPlugin

  formatItemValues, replaceDynamicValues

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  LucenePlugin

  public LucenePlugin()

  Method Detail

  init

  public void init(org.imixs.workflow.WorkflowContext actx)
            throws Exception

  Specified by:

  init in interface org.imixs.workflow.Plugin

  Overrides:

  init in class AbstractPlugin

  Throws:

  Exception

  run

  public int run(org.imixs.workflow.ItemCollection documentContext,
                 org.imixs.workflow.ItemCollection activity)
          throws Exception

  This method adds the current workitem to the search index by calling the method addWorkitem. The method computes temporarily the field $processid based on the numnextprocessid from teh activty entity. This will ensure that the workitem is indexed correctly on the $processid the workitem will hold after the process step is completed. If and how the workitem will be added to the search index is fully controlled by the method addWorkitem.

  Throws:

  Exception

  close

  public void close(int status)
             throws Exception

  Throws:

  Exception

  addWorkitem

  public static boolean addWorkitem(org.imixs.workflow.ItemCollection documentContext)
                             throws Exception

  This method adds a single workitem into the search index. The adds the workitem into a empty Collection and calls teh method addWorklist.

  Parameters:

  documentContext -

  Returns:

  Throws:

  Exception

  addWorklist

  public static boolean addWorklist(Collection<org.imixs.workflow.ItemCollection> worklist)
                             throws Exception

  This method adds a collection of workitems into the search index. The method loads the imixs-search.properties file from the classpath. If no properties are defined the method terminates. For each workitem the method test if it did match the conditions to be added into the search index. If the workitem did not match the conditions the workitem will be removed from the index.

  Parameters:

  worklist -

  Returns:

  Throws:

  Exception

  matchConditions

  public static boolean matchConditions(Properties prop,
                                        org.imixs.workflow.ItemCollection aworktiem)

  test if the workitem matches the conditions to be added into the search index. The Property keys MatchingType and MatchingProcessID can provide regular expressions

  Parameters:

  aworktiem -

  Returns:

  search

  public static List<org.imixs.workflow.ItemCollection> search(String sSearchTerm,
                                                               WorkflowService workflowService)
                                                        throws Exception

  Returns a ItemCollection List matching the provided search term. The provided search team will we extended with a users roles to test the read access level of each workitem matching the search term. The usernames and user roles will be search lowercase!

  Parameters:

  sSearchTerm -

  workflowService -

  Returns:

  collection of search result

  Throws:

  Exception

  createDocument

  public static org.apache.lucene.document.Document createDocument(Properties prop,
                                                                   org.imixs.workflow.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:

  createIndexWriter

  public static org.apache.lucene.index.IndexWriter createIndexWriter(Properties prop)
                                                               throws Exception

  This method creates a new instance of a lucene IndexWriter. The timeout to wait for a write lock is set to 10 seconds.

  Returns:

  Throws:

  Exception

  createIndexSearcher

  public static org.apache.lucene.search.IndexSearcher createIndexSearcher()
                                                                    throws Exception

  Throws:

  Exception

  loadProperties

  public static Properties loadProperties()
                                   throws Exception

  loads a imixs-search.property file

  Returns:

  Throws:

  Exception