net.sf.mmm.search.engine.api

Interface ManagedSearchEngine

All Superinterfaces:

AutoCloseable, Closeable, Refreshable, SearchEngine

All Known Implementing Classes:

AbstractSearchEngine, LuceneSearchEngine

public interface ManagedSearchEngine
extends SearchEngine, Closeable, Refreshable

This is the interface for a managed SearchEngine. It extends SearchEngine with additional management methods.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	close() This method disposes the search-engine.
boolean	refresh() This method tells the search-engine to refresh explicitly.

Methods inherited from interface net.sf.mmm.search.engine.api.SearchEngine

count, getEntry, getQueryBuilder, getTotalEntryCount, search, search

Method Detail

refresh

boolean refresh()

This method tells the search-engine to refresh explicitly. Depending on the implementation this may cause that the search index is reread from the disk or that caches are purged. The implementation is expected to be smart in a way that it only rebuilds things if things really have changed since creation or the last call of refresh().
This can be an expensive operation and should NOT be called per search request. This method refreshes the given object. This can be anything from reloading configuration to rebuilding the internal state. An invocation of this method may be expensive and should only be invoked as needed. The implementation of this method should be thread-safe if the object itself is to be used by separate consumers at all.

Specified by:

refresh in interface Refreshable

Returns:

true if something has changed, false otherwise. If the implementation can not determine the change it should return true.

close

void close()

This method disposes the search-engine. This method needs to be called when the search-engine is NOT used anymore. It will free used resources (e.g. close streams, etc.). After the call of this method this search-engine AND all results retrieved from this search-engine can NOT be used anymore.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable