net.sf.mmm.search.indexer.base

Class AbstractSearchIndexer

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, SearchIndexer

Direct Known Subclasses:

LuceneSearchIndexer

public abstract class AbstractSearchIndexer
extends AbstractLoggableObject
implements SearchIndexer

This is the abstract base implementation of the SearchIndexer interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractSearchIndexer() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	add(MutableSearchEntry entry, Long id)
boolean	remove(SearchHit hit) This method removes an existing entry identified by the given hit.
protected int	remove(SearchResultPage page) This method removes all hits of the given SearchResultPage.
int	removeByCustumId(String uid) This method removes an existing entry identified by the given uri from the search-index.
boolean	removeById(Long id) This method removes an existing entry identified by the given id from the search-index.
int	removeByUri(String uri, String sourceId) This method removes an existing entry identified by the given uri from the search-index.
protected SearchResultPage	search(Long id, Object cid, String uri, String source) This method searches the entries with the specified properties.
int	update(MutableSearchEntry entry) This method updates the given entry in the search-index.

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

add, close, createEntry, flush, getSearchEngine, optimize, remove

Constructor Detail

AbstractSearchIndexer

public AbstractSearchIndexer()

The constructor.

Method Detail

add

protected abstract void add(MutableSearchEntry entry,
                            Long id)

Parameters:

entry - is the MutableSearchEntry to add.

id - is the ID for the entry.

See Also:

SearchIndexer.add(MutableSearchEntry)

update

public int update(MutableSearchEntry entry)
           throws SearchException

This method updates the given entry in the search-index. This method will use the property SearchEntry.FIELD_CUSTOM_ID to identify a potentially existing entry to update. Otherwise it will use a combination of SearchEntry.FIELD_URI and SearchEntry.FIELD_SOURCE as identifier (what is NOT a very strong ID as the URI can change).

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 identifier what indicates a mistake of your index or the indexer.

Throws:

SearchException - if the operation failed.

remove

public boolean remove(SearchHit hit)
               throws SearchException

This method removes an existing entry identified by the given hit. In most cases this method will delegate to SearchIndexer.removeById(Long). However the implementation can decide what is the best way to do it.

Specified by:

remove in interface SearchIndexer

Parameters:

hit - is the SearchHit to remove.

Returns:

true if the entry existed and has been removed from the index, false if NO entry exists for the given hit.

Throws:

SearchException - if the operation failed.

removeByCustumId

public int removeByCustumId(String uid)
                     throws SearchException

This method removes an existing entry identified by the given uri from the search-index.

Specified by:

removeByCustumId in interface SearchIndexer

Parameters:

uid - is the custom-ID of an entry previously added to the index.

Returns:

the number of entries that have been removed. This should typically be 1 if one entry exists with the given uid or 0 if no such entry exists. A value greater than 1 indicates that multiple entries have been removed that all have the given uid what indicates a mistake of your index(er). A value of -1 means the number is unknown because this is not supported by the implementation.

Throws:

SearchException - if the operation failed.

See Also:

SearchIndexer.update(MutableSearchEntry)

removeById

public boolean removeById(Long id)
                   throws SearchException

This method removes an existing entry identified by the given id from the search-index.
ATTENTION:
If you are using lucene as implementation according to some questionable design of lucene this method has to close the IndexWriter and create an IndexReader to perform the delete. If you invoke an other method after that the same has to be done reverse. This can cause really bad performance.

Specified by:

removeById in interface SearchIndexer

Parameters:

id - is the ID of the entry to remove (NOT null).

Returns:

true if the entry existed and has been removed from the index, false if NO entry exists for the given id.

Throws:

SearchException - if the operation failed.

removeByUri

public int removeByUri(String uri,
                       String sourceId)
                throws SearchException

This method removes an existing entry identified by the given uri from the search-index.

Specified by:

removeByUri in interface SearchIndexer

Parameters:

uri - is the URI of an entry previously added to the index.

sourceId - is the ID of the SearchSource. This is required because the uri itself may NOT be unique (e.g. different sources might both contain the entry with URI "index.html").

Returns:

the number of entries that have been removed. This should typically be 1 if one entry exists with the given uri or 0 if no such entry exists. A value greater than 1 indicates that multiple entries have been removed that all have the given uri. A value of -1 means the number is unknown because this is not supported by the implementation.

Throws:

SearchException - if the operation failed.

See Also:

SearchIndexer.update(MutableSearchEntry)

remove

protected int remove(SearchResultPage page)

This method removes all hits of the given SearchResultPage.

Parameters:

page - is the SearchResultPage to delete.

Returns:

the value of SearchResultPage.getPageCount().

search

protected SearchResultPage search(Long id,
                                  Object cid,
                                  String uri,
                                  String source)

This method searches the entries with the specified properties. At least one of the properties has to be set (not null).

Parameters:

id - is the ID or null if any ID should match.

cid - is the custom-ID or null if any custom-ID should match.

uri - is the URI or null if any URI should match.

source - is the source or null if any source should match.

Returns:

the SearchResultPage for the specified query.