org.sakaiproject.search
Interface SearchIndexBuilder

All Known Implementing Classes:
SearchIndexBuilderImpl

public interface SearchIndexBuilder

A SearchIndexBuilder builds a search index, it must manage its own list of pending documents and should probably do this in a seperate thread

Author:
ieb

Method Summary
 void addResource(Notification notification, Event event)
          Adds a resource to the index builder
 void destroy()
          Close down the entire search infrastructure
 List getContentProducers()
          get all the producers registerd, as a clone to avoid concurrent modification exceptions
 int getPendingDocuments()
          get the number of pending documents
 boolean isBuildQueueEmpty()
          Does the Queue contain work to do.
 void rebuildIndex()
          rebuild the index completely from scratch
 void refreshIndex()
          Refresh the index based on the registered entities
 void registerEntityContentProducer(EntityContentProducer ecp)
          EntityProducers that want their content indexed on full text must register an EntityContentProducer with the SearchIndexBuilder
 

Method Detail

addResource

public void addResource(Notification notification,
                        Event event)
Adds a resource to the index builder

Parameters:
notification -
event -

registerEntityContentProducer

public void registerEntityContentProducer(EntityContentProducer ecp)
EntityProducers that want their content indexed on full text must register an EntityContentProducer with the SearchIndexBuilder

Parameters:
ecp -

refreshIndex

public void refreshIndex()
Refresh the index based on the registered entities


rebuildIndex

public void rebuildIndex()
rebuild the index completely from scratch


isBuildQueueEmpty

public boolean isBuildQueueEmpty()
Does the Queue contain work to do.

Returns:

getContentProducers

public List getContentProducers()
get all the producers registerd, as a clone to avoid concurrent modification exceptions

Returns:

destroy

public void destroy()
Close down the entire search infrastructure


getPendingDocuments

public int getPendingDocuments()
get the number of pending documents

Returns: