net.firstpartners.rp.plugins
Interface IIndexManager

All Superinterfaces:

IPlugin

All Known Implementing Classes:

BasicIndex

public interface IIndexManager
extends IPlugin

Stores information about things that we wish to search later.

Author:

brownpa

Method Summary

void	addToIndex(org.apache.lucene.document.Document documentToUpdate) Quick reindex for the documents with the specified id
java.lang.String	getRoot() Get the root folder for the index
void	optimize()
void	reindex(org.apache.lucene.document.Document[] documentsToUpdate) Quick reindex for the documents with the specified id
void	reindex(java.lang.String id, double score) Quick reindex for the documents with the specified id to the new score
void	removeFromIndex(java.lang.String uniqueId) Remove a piece of information from the index

Methods inherited from interface net.firstpartners.rp.plugins.IPlugin

onLoad

Method Detail

addToIndex

void addToIndex(org.apache.lucene.document.Document documentToUpdate)

Quick reindex for the documents with the specified id

Parameters:

documentToUpdate -

reindex

void reindex(org.apache.lucene.document.Document[] documentsToUpdate)

Quick reindex for the documents with the specified id

Parameters:

documentsToUpdate -

reindex

void reindex(java.lang.String id,
             double score)

Quick reindex for the documents with the specified id to the new score

Parameters:

id - Document ID

score - The new sorting score

removeFromIndex

void removeFromIndex(java.lang.String uniqueId)

Remove a piece of information from the index

Parameters:

uniqueId -

getRoot

java.lang.String getRoot()

Get the root folder for the index

Returns:

optimize

void optimize()