org.sakaiproject.search.api
Interface SearchIndexBuilder

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 separate thread

Author:

ieb

Method Summary

void	addResource(org.sakaiproject.event.api.Notification notification, org.sakaiproject.event.api.Event event) Adds a resource to the index builder
void	destroy() Close down the entire search infrastructure
List<SearchBuilderItem>	getAllSearchItems() get a list of all entitied in the search index
List<EntityContentProducer>	getContentProducers() get all the producers registerd, as a clone to avoid concurrent modification exceptions
List<SearchBuilderItem>	getGlobalMasterSearchItems() get a list of global search items
int	getPendingDocuments() get the number of pending documents
List<SearchBuilderItem>	getSiteMasterSearchItems() get a list of Master Search Items that control the search operation for the Site (current site)
boolean	isBuildQueueEmpty() Does the Queue contain work to do.
boolean	isExcludeUserSites()
boolean	isOnlyIndexSearchToolSites()
EntityContentProducer	newEntityContentProducer(org.sakaiproject.event.api.Event event) get an entity content producer that can handle the event
EntityContentProducer	newEntityContentProducer(String ref) get an entity content procuder that can handle the reference
void	rebuildIndex() rebuild the index completely from scratch
void	rebuildIndex(String currentSiteId) Rebuild the index for the supplied siteId
void	refreshIndex() Refresh the index based on the registered entities
void	refreshIndex(String currentSiteId) Refresh the index for the supplied siteId
void	registerEntityContentProducer(EntityContentProducer ecp) EntityProducers that want their content indexed on full text must register an EntityContentProducer with the SearchIndexBuilder

Method Detail

addResource

void addResource(org.sakaiproject.event.api.Notification notification,
                 org.sakaiproject.event.api.Event event)

Adds a resource to the index builder

Parameters:

notification -

event -

registerEntityContentProducer

void registerEntityContentProducer(EntityContentProducer ecp)

EntityProducers that want their content indexed on full text must register an EntityContentProducer with the SearchIndexBuilder

Parameters:

ecp -

refreshIndex

void refreshIndex()

Refresh the index based on the registered entities

rebuildIndex

void rebuildIndex()

rebuild the index completely from scratch

isBuildQueueEmpty

boolean isBuildQueueEmpty()

Does the Queue contain work to do.

Returns:

getContentProducers

List<EntityContentProducer> getContentProducers()

get all the producers registerd, as a clone to avoid concurrent modification exceptions

Returns:

destroy

void destroy()

Close down the entire search infrastructure

getPendingDocuments

int getPendingDocuments()

get the number of pending documents

Returns:

rebuildIndex

void rebuildIndex(String currentSiteId)

Rebuild the index for the supplied siteId

Parameters:

currentSiteId -

refreshIndex

void refreshIndex(String currentSiteId)

Refresh the index for the supplied siteId

Parameters:

currentSiteId -

getAllSearchItems

List<SearchBuilderItem> getAllSearchItems()

get a list of all entitied in the search index

Returns:

newEntityContentProducer

EntityContentProducer newEntityContentProducer(org.sakaiproject.event.api.Event event)

get an entity content producer that can handle the event

Parameters:

event -

Returns:

newEntityContentProducer

EntityContentProducer newEntityContentProducer(String ref)

get an entity content procuder that can handle the reference

Parameters:

ref -

Returns:

getSiteMasterSearchItems

List<SearchBuilderItem> getSiteMasterSearchItems()

get a list of Master Search Items that control the search operation for the Site (current site)

Returns:

getGlobalMasterSearchItems

List<SearchBuilderItem> getGlobalMasterSearchItems()

get a list of global search items

Returns:

isOnlyIndexSearchToolSites

boolean isOnlyIndexSearchToolSites()

isExcludeUserSites

boolean isExcludeUserSites()