org.carewebframework.help.lucene

Class HelpSearchService

java.lang.Object

org.carewebframework.help.lucene.HelpSearchService

All Implemented Interfaces:

IHelpSearch, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class HelpSearchService
extends Object
implements IHelpSearch, org.springframework.context.ApplicationContextAware

Service for managing the search index and providing search capabilities using Lucene.

Nested Class Summary

Nested classes/interfaces inherited from interface org.carewebframework.help.IHelpSearch

IHelpSearch.IHelpSearchListener

Method Summary

Modifier and Type	Method and Description
void	destroy() Release/update resources upon destruction.
static HelpSearchService	getInstance()
void	indexHelpModule(HelpModule helpModule) Index all HTML files within the content of the help module.
void	init() Initialize the index writer.
void	search(String words, Collection<IHelpSet> helpSets, IHelpSearch.IHelpSearchListener listener) Performs a search query using the specified string on each registered query handler, calling the listener for each set of results.
void	setApplicationContext(org.springframework.context.ApplicationContext appContext) Application context is needed to iterate over help content resources.
void	setIndexDirectoryPath(String path) Setter for index directory path (injected by IOC container).
void	unindexHelpModule(HelpModule helpModule) Removes the index for a help module.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HelpSearchService getInstance()

setIndexDirectoryPath

public void setIndexDirectoryPath(String path)

Setter for index directory path (injected by IOC container).

Parameters:

path - The index directory path (may be null or empty).

indexHelpModule

public void indexHelpModule(HelpModule helpModule)

Index all HTML files within the content of the help module.

Specified by:

indexHelpModule in interface IHelpSearch

Parameters:

helpModule - Help module to be indexed.

unindexHelpModule

public void unindexHelpModule(HelpModule helpModule)

Removes the index for a help module.

Specified by:

unindexHelpModule in interface IHelpSearch

Parameters:

helpModule - Help module whose index is to be removed.

search

public void search(String words,
                   Collection<IHelpSet> helpSets,
                   IHelpSearch.IHelpSearchListener listener)

Performs a search query using the specified string on each registered query handler, calling the listener for each set of results.

Specified by:

search in interface IHelpSearch

Parameters:

words - List of words to be located.

helpSets - Help sets to be searched

listener - Listener for search results.

init

public void init()
          throws IOException

Initialize the index writer.

Throws:

IOException - Unspecified IO exception.

destroy

public void destroy()

Release/update resources upon destruction.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext appContext)
                           throws org.springframework.beans.BeansException

Application context is needed to iterate over help content resources.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException