com.ecyrd.jspwiki.search
Class BasicSearchProvider

java.lang.Object
  extended by com.ecyrd.jspwiki.search.BasicSearchProvider
All Implemented Interfaces:
SearchProvider, WikiProvider

public class BasicSearchProvider
extends Object
implements SearchProvider

Interface for the search providers that handle searching the Wiki

Since:
2.2.21.
Author:
Arent-Jan Banck for Informatica

Field Summary
 
Fields inherited from interface com.ecyrd.jspwiki.WikiProvider
LATEST_VERSION
 
Constructor Summary
BasicSearchProvider()
           
 
Method Summary
 Collection findPages(String query)
          Search for pages matching a search query
 String getProviderInfo()
          Return a valid HTML string for information.
 void initialize(WikiEngine engine, Properties props)
          Initializes the page provider.
 void pageRemoved(WikiPage page)
          Delete a page from the search index
 QueryItem[] parseQuery(String query)
           
 void reindexPage(WikiPage page)
          Adds a WikiPage for indexing queue.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicSearchProvider

public BasicSearchProvider()
Method Detail

initialize

public void initialize(WikiEngine engine,
                       Properties props)
                throws NoRequiredPropertyException,
                       IOException
Description copied from interface: WikiProvider
Initializes the page provider.

Specified by:
initialize in interface WikiProvider
Throws:
NoRequiredPropertyException
IOException

pageRemoved

public void pageRemoved(WikiPage page)
Description copied from interface: SearchProvider
Delete a page from the search index

Specified by:
pageRemoved in interface SearchProvider
Parameters:
page - Page to remove from search index

reindexPage

public void reindexPage(WikiPage page)
Description copied from interface: SearchProvider
Adds a WikiPage for indexing queue. This is called a queue, since this method is expected to return pretty quickly, and indexing to be done in a separate thread.

Specified by:
reindexPage in interface SearchProvider
Parameters:
page - The WikiPage to be indexed.

parseQuery

public QueryItem[] parseQuery(String query)

findPages

public Collection findPages(String query)
Description copied from interface: SearchProvider
Search for pages matching a search query

Specified by:
findPages in interface SearchProvider
Parameters:
query - query to search for
Returns:
collection of pages that match query

getProviderInfo

public String getProviderInfo()
Description copied from interface: WikiProvider
Return a valid HTML string for information. May be anything.

Specified by:
getProviderInfo in interface WikiProvider
See Also:
WikiProvider.getProviderInfo()