Package org.apache.wiki.search

Class DefaultSearchManager

java.lang.Object

org.apache.wiki.api.filters.BasePageFilter

org.apache.wiki.search.DefaultSearchManager

All Implemented Interfaces:

java.util.EventListener, PageFilter, WikiEventListener, InternalModule, SearchManager

public class DefaultSearchManager
extends BasePageFilter
implements SearchManager

Manages searching the Wiki.

Since:

2.2.21.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DefaultSearchManager.JSONSearch	Provides a JSON AJAX API to the JSPWiki Search Engine.

Field Summary

Fields inherited from class org.apache.wiki.api.filters.BasePageFilter

m_engine

Fields inherited from interface org.apache.wiki.search.SearchManager

DEFAULT_SEARCHPROVIDER, JSON_SEARCH, PROP_SEARCHPROVIDER

Constructor Summary

Constructors

Constructor	Description
DefaultSearchManager(Engine engine, java.util.Properties properties)	Creates a new SearchManager.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(WikiEvent event)	Fired when a WikiEvent is triggered by an event source.
SearchProvider	getSearchEngine()	Returns the SearchProvider used.
void	initialize(Engine engine, java.util.Properties properties)	If you override this, you should call super.initialize() first.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wiki.api.filters.PageFilter

destroy, postSave, postTranslate, preSave, preTranslate

Methods inherited from interface org.apache.wiki.search.SearchManager

findPages, pageRemoved, reindexPage

Constructor Details

DefaultSearchManager

public DefaultSearchManager(Engine engine,
java.util.Properties properties)
                     throws FilterException

Creates a new SearchManager.

Parameters:

engine - The Engine that owns this SearchManager.

properties - The list of Properties.

Throws:

FilterException - If it cannot be instantiated.

Method Details

initialize

public void initialize(Engine engine,
java.util.Properties properties)
                throws FilterException

If you override this, you should call super.initialize() first. Is called whenever the a new PageFilter is instantiated and reset.

Specified by:

initialize in interface PageFilter

Overrides:

initialize in class BasePageFilter

Parameters:

engine - The Engine which owns this PageFilter

properties - The properties ripped from filters.xml.

Throws:

FilterException - If the filter could not be initialized. If this is thrown, the filter is not added to the internal queues.

getSearchEngine

public SearchProvider getSearchEngine()

Returns the SearchProvider used.

Specified by:

getSearchEngine in interface SearchManager

Returns:

The current SearchProvider.

actionPerformed

public void actionPerformed(WikiEvent event)

Fired when a WikiEvent is triggered by an event source.

Specified by:

actionPerformed in interface WikiEventListener

Parameters:

event - a WikiEvent object