net.sf.mmm.search.engine.base

Class AbstractSearchEngine

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.search.engine.base.AbstractSearchEngine

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedSearchEngine, SearchEngine, Refreshable

Direct Known Subclasses:

LuceneSearchEngine

public abstract class AbstractSearchEngine
extends AbstractLoggableObject
implements ManagedSearchEngine

This is the abstract base implementation of the ManagedSearchEngine interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

initialize()

Field Summary

Fields

Modifier and Type	Field and Description
private PeriodicRefresher	periodicRefresher The PeriodicRefresher.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchEngine(PeriodicRefresher periodicRefresher) The constructor.

Method Summary

Modifier and Type	Method and Description
void	close() This method disposes the search-engine.
void	initialize() This method initializes this engine.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

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

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

refresh

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

count, getEntry, getQueryBuilder, getTotalEntryCount, search, search

Field Detail

periodicRefresher

private final PeriodicRefresher periodicRefresher

The PeriodicRefresher.

Constructor Detail

AbstractSearchEngine

public AbstractSearchEngine(PeriodicRefresher periodicRefresher)

The constructor.

Parameters:

periodicRefresher - is the PeriodicRefresher.

Method Detail

initialize

public void initialize()

This method initializes this engine. It should be called after construction.

close

public 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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ManagedSearchEngine