net.sf.mmm.search.indexer.base
Class AbstractSearchIndexer

java.lang.Object
  net.sf.mmm.search.indexer.base.AbstractSearchIndexer

All Implemented Interfaces:

SearchIndexer

Direct Known Subclasses:

LuceneSearchIndexer

public abstract class AbstractSearchIndexer
extends Object
implements SearchIndexer

This is the abstract base implementation of the SearchIndexer interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

AbstractSearchIndexer()
The constructor.

Method Summary

int	update(MutableSearchEntry entry) This method updates the given entry in the search-index.

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.indexer.api.SearchIndexer

add, close, createEntry, flush, optimize, remove, removeById, removeByUid, removeByUri

Constructor Detail

AbstractSearchIndexer

public AbstractSearchIndexer()

The constructor.

Method Detail

update

public int update(MutableSearchEntry entry)
           throws SearchException

This method updates the given entry in the search-index. This method assumes that the property SearchEntry.PROPERTY_UID (prior) or SearchEntry.PROPERTY_URI (fallback) is used as unique identifier for entries.

Specified by:

update in interface SearchIndexer

Parameters:

entry - is the entry to update.

Returns:

the number of entries that have been replaced. This should typically be 1 if one entry was replaced or 0 none was replaced and the given entry has only been added. A value greater than 1 indicates that multiple entries have been replaced that all have the same uri or id what indicates a mistake of your index(er).

Throws:

SearchException - if the operation failed.