net.sf.mmm.search.indexer.impl.lucene

Class LuceneSearchIndexer

java.lang.Object

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

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

net.sf.mmm.search.indexer.impl.lucene.LuceneSearchIndexer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, SearchIndexer

public class LuceneSearchIndexer
extends AbstractSearchIndexer

This is the implementation of SearchIndexer using lucene as underlying search-engine.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private int	addCounter The number of entries added in this session.
private LuceneFieldManager	fieldManager The LuceneFieldManager.
private org.apache.lucene.index.IndexWriter	indexWriter The IndexWriter.
private SearchDependencies	searchDependencies The SearchDependencies.
private ManagedSearchEngine	searchEngine
private LuceneSearchEngineBuilder	searchEngineBuilder
private long	sessionId The base-ID for this session.

Constructor Summary

Constructors

Constructor and Description
LuceneSearchIndexer(org.apache.lucene.index.IndexWriter indexWriter, LuceneSearchEngineBuilder searchEngineBuilder, LuceneFieldManager fieldManager, SearchDependencies searchDependencies) The constructor.

Method Summary

Modifier and Type	Method and Description
void	add(MutableSearchEntry entry) This method adds the given entry to the search-index.
protected void	add(MutableSearchEntry entry, Long id)
void	close() This method closes the search index.
MutableSearchEntry	createEntry() This method creates a new and empty entry for the search-index.
void	flush() This method flushes the search index what ensures that all changes are written to the index.
protected org.apache.lucene.index.IndexWriter	getIndexWriter() This method gets the IndexWriter.
SearchEngine	getSearchEngine() This method gets the SearchEngine for the index of this SearchIndexer.
void	optimize() This method optimizes the search index.
int	remove(String field, Object value) This method removes all existing entries identified by the given value at the given property from the search-index.
protected int	remove(org.apache.lucene.index.Term term) This method performs the actual remove by Term.

Methods inherited from class net.sf.mmm.search.indexer.base.AbstractSearchIndexer

remove, remove, removeByCustumId, removeById, removeByUri, search, update

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

Field Detail

searchEngineBuilder

private final LuceneSearchEngineBuilder searchEngineBuilder

See Also:

getSearchEngine()

fieldManager

private final LuceneFieldManager fieldManager

The LuceneFieldManager.

searchDependencies

private final SearchDependencies searchDependencies

The SearchDependencies.

See Also:

createEntry()

sessionId

private final long sessionId

The base-ID for this session. It is combined with addCounter to create IDs.

addCounter

private int addCounter

The number of entries added in this session.

indexWriter

private org.apache.lucene.index.IndexWriter indexWriter

The IndexWriter.

searchEngine

private ManagedSearchEngine searchEngine

See Also:

getSearchEngine()

Constructor Detail

LuceneSearchIndexer

public LuceneSearchIndexer(org.apache.lucene.index.IndexWriter indexWriter,
                           LuceneSearchEngineBuilder searchEngineBuilder,
                           LuceneFieldManager fieldManager,
                           SearchDependencies searchDependencies)

The constructor.

Parameters:

indexWriter - is the index modifier to use.

searchEngineBuilder - is the LuceneSearchEngineBuilder required for getSearchEngine().

fieldManager - is the LuceneFieldManager.

searchDependencies - are the SearchDependencies.

Method Detail

getIndexWriter

protected org.apache.lucene.index.IndexWriter getIndexWriter()

This method gets the IndexWriter.

Returns:

the IndexWriter.

add

public void add(MutableSearchEntry entry)
         throws SearchException

This method adds the given entry to the search-index.

Parameters:

entry - is the entry to add.

Throws:

SearchException - if the operation failed.

add

protected void add(MutableSearchEntry entry,
                   Long id)
            throws SearchException

Specified by:

add in class AbstractSearchIndexer

Parameters:

entry - is the MutableSearchEntry to add.

id - is the ID for the entry.

Throws:

SearchException

See Also:

SearchIndexer.add(MutableSearchEntry)

close

public void close()

This method closes the search index. After the call of this method no other method of this object shall be invoked.

flush

public void flush()
           throws SearchException

This method flushes the search index what ensures that all changes are written to the index. If NOT supported by the implementation, this method will have no effect.

Throws:

SearchException - if the operation failed.

createEntry

public MutableSearchEntry createEntry()

This method creates a new and empty entry for the search-index. After the entry is filled with data, use SearchIndexer.add(MutableSearchEntry) to add it to the search index.

Returns:

a new and empty search-index entry.

optimize

public void optimize()
              throws SearchException

This method optimizes the search index. If NOT supported by the implementation, this method will have no effect. Optimization will typically cause some performance overhead but therefore speed up your searches.

Throws:

SearchException - if the operation failed.

remove

protected int remove(org.apache.lucene.index.Term term)

This method performs the actual remove by Term.

Parameters:

term - is the Term identifying the entry/entries to remove.

Returns:

the number of removed entries.

See Also:

AbstractSearchIndexer.removeByCustumId(String), AbstractSearchIndexer.removeByUri(String, String), IndexWriter.deleteDocuments(Term)

remove

public int remove(String field,
                  Object value)
           throws SearchException

This method removes all existing entries identified by the given value at the given property from the search-index.
ATTENTION:
Please use this method with care.

Parameters:

field - is the name of the field where the value is expected to occur. Therefore the field should NOT to be of the type SearchFieldType.TEXT.

value - is the value of the field.

Returns:

the number of entries that have been removed or -1 if the number is unknown because this is not supported by the implementation.

Throws:

SearchException - if the operation failed.

getSearchEngine

public SearchEngine getSearchEngine()

This method gets the SearchEngine for the index of this SearchIndexer. It may be used for advanced indexing where search-queries need to performed for updating the search-index.

Returns:

the SearchEngine.