org.imixs.workflow.engine.lucene

Class LuceneSearchService

java.lang.Object

org.imixs.workflow.engine.lucene.LuceneSearchService

@DeclareRoles(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
 @RolesAllowed(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
public class LuceneSearchService
extends Object

This session ejb provides a service to search the lucene index. The EJB uses the IndexSearcher to query the current index. As the index can change across multiple searches we can not share a single IndexSearcher instance. For that reason the EJB is creating a new IndexSearch per-search. The service provides a set of public methods which can be used to query workitems or collections of workitems. A search term can be escaped by calling the method escpeSearchTerm. This method prepends a \ for those characters that QueryParser expects to be escaped.

Version:

2.0

Author:

rsoika

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_SEARCH_RESULT
static int	DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
LuceneSearchService()

Method Summary

Modifier and Type	Method and Description
static String	escapeSearchTerm(String searchTerm)
static String	escapeSearchTerm(String searchTerm, boolean ignoreBracket) This helper method escapes wildcard tokens found in a lucene search term.
void	flush() This method flush the event log.
int	getTotalHits(String sSearchTerm, int maxResult, org.apache.lucene.queryparser.classic.QueryParser.Operator defaultOperator) Returns the total hits for a given search term from the lucene index.
static String	normalizeSearchTerm(String searchTerm) This method normalizes a search term using the Lucene ClassicTokenzier.
List<ItemCollection>	search(String sSearchTerm) Returns a collection of documents matching the provided search term.
List<ItemCollection>	search(String sSearchTerm, int pageSize, int pageIndex) Returns a collection of documents matching the provided search term.
List<ItemCollection>	search(String sSearchTerm, int pageSize, int pageIndex, org.apache.lucene.search.Sort sortOrder, org.apache.lucene.queryparser.classic.QueryParser.Operator defaultOperator) Returns a collection of documents matching matching the provided search term.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SEARCH_RESULT

public static final int DEFAULT_MAX_SEARCH_RESULT

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

LuceneSearchService

public LuceneSearchService()

Method Detail

search

public List<ItemCollection> search(String sSearchTerm)
                            throws QueryException

Returns a collection of documents 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.

Parameters:

sSearchTerm -

Returns:

collection of search result

Throws:

QueryException

search

public List<ItemCollection> search(String sSearchTerm,
                                   int pageSize,
                                   int pageIndex)
                            throws QueryException

Returns a collection of documents 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.

Parameters:

pageSize - - docs per page

pageIndex - - page number

Returns:

collection of search result

Throws:

QueryException

search

public List<ItemCollection> search(String sSearchTerm,
                                   int pageSize,
                                   int pageIndex,
                                   org.apache.lucene.search.Sort sortOrder,
                                   org.apache.lucene.queryparser.classic.QueryParser.Operator defaultOperator)
                            throws QueryException

Returns a collection of documents matching matching the provided search term. The provided search term will we extended with a users roles to test the read access level of each workitem matching the search term.

The optional param 'searchOrder' can be set to force lucene to sort the search result by any search order.

The optional param 'defaultOperator' can be set to Operator.AND

Parameters:

sSearchTerm -

pageSize - - docs per page

pageIndex - - page number

sortOrder - - optional to sort the result

defaultOperator - - optional to change the default search operator

Returns:

collection of search result

Throws:

QueryException - in case the searchtem is not understandable.

flush

public void flush()

This method flush the event log.

getTotalHits

public int getTotalHits(String sSearchTerm,
                        int maxResult,
                        org.apache.lucene.queryparser.classic.QueryParser.Operator defaultOperator)
                 throws QueryException

Returns the total hits for a given search term from the lucene index. The method did not load any data. The provided search term will we extended with a users roles to test the read access level of each workitem matching the search term. The optional param 'maxResult' can be set to overwrite the DEFAULT_MAX_SEARCH_RESULT.

Parameters:

sSearchTerm -

maxResult - - max search result

Returns:

total hits of search result

Throws:

QueryException - in case the searchterm is not understandable.

See Also:

search(String, int, int, Sort, Operator)

escapeSearchTerm

public static String escapeSearchTerm(String searchTerm,
                                      boolean ignoreBracket)

This helper method escapes wildcard tokens found in a lucene search term. The method can be used by clients to prepare a search phrase. The method rewrites the lucene QueryParser.escape method and did not! escape '*' char. Clients should use the method normalizeSearchTerm() instead of escapeSearchTerm() to prepare a user input for a lucene search.

Parameters:

searchTerm -

ignoreBracket - - if true brackes will not be escaped.

Returns:

escaped search term

See Also:

normalizeSearchTerm

escapeSearchTerm

public static String escapeSearchTerm(String searchTerm)

normalizeSearchTerm

public static String normalizeSearchTerm(String searchTerm)
                                  throws QueryException

This method normalizes a search term using the Lucene ClassicTokenzier. The method can be used by clients to prepare a search phrase. The method also escapes the result search term. e.g. 'europe/berlin' will be normalized to 'europe berlin' e.g. 'r555/333' will be unmodified 'r555/333'

Parameters:

searchTerm -

Returns:

normalzed search term

Throws:

QueryException