SearchIndexBuilderImpl (search-impl 1.4.0-b06 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sakaiproject.search.component.service.impl
Class SearchIndexBuilderImpl

java.lang.Object
  org.sakaiproject.search.component.service.impl.SearchIndexBuilderImpl

All Implemented Interfaces:: SearchIndexBuilder

public class SearchIndexBuilderImpl
extends Object
implements SearchIndexBuilder
extends Object
implements SearchIndexBuilder

Search index builder is expected to be registered in spring as org.sakaiproject.search.api.SearchIndexBuilder as a singleton. It receives resources which it adds to its list of pending documents to be indexed. A Separate thread then runs through the list of entities to be indexed, updating the index. Each time the index is updates an event is posted to force the Search components that are using the index to reload. Incremental updates to the Lucene index require that the searchers reload the index once the index writer has been built.

Author:: ieb

Constructor Summary
`SearchIndexBuilderImpl()`

Method Summary
`void`	`addIndexQueueListener(IndexQueueListener indexQueueListener)`
`void`	`addResource(org.sakaiproject.event.api.Notification notification, org.sakaiproject.event.api.Event event)` Add a resource to the indexing queue
`void`	`destroy()`
`protected void`	`fireResourceAdded(String name)`
`List<SearchBuilderItem>`	`getAllSearchItems()`
`List<EntityContentProducer>`	`getContentProducers()` get all the producers registerd, as a clone to avoid concurrent modification exceptions
`List<SearchBuilderItem>`	`getGlobalMasterSearchItems()`
`int`	`getPendingDocuments()`
`SearchBuilderItemDao`	`getSearchBuilderItemDao()`
`List<SearchBuilderItem>`	`getSiteMasterSearchItems()`
`void`	`init()`
`boolean`	`isBuildQueueEmpty()` return true if the queue is empty
`boolean`	`isExcludeUserSites()`
`boolean`	`isOnlyIndexSearchToolSites()`
`EntityContentProducer`	`newEntityContentProducer(org.sakaiproject.event.api.Event event)` get hold of an entity content producer using the event
`EntityContentProducer`	`newEntityContentProducer(String ref)` Generates a SearchableEntityProducer
`void`	`rebuildIndex()` Rebuild the index from the entities own stored state
`void`	`rebuildIndex(String currentSiteId)` Rebuild the index from the entities own stored state , just the supplied siteId
`void`	`refreshIndex()` refresh the index from the current stored state
`void`	`refreshIndex(String currentSiteId)` Refresh the index fo the supplied site.
`void`	`registerEntityContentProducer(EntityContentProducer ecp)` register an entity content producer to provide content to the search engine
`void`	`removeIndexQueueListener(IndexQueueListener indexQueueListener)`
`void`	`setExcludeUserSites(boolean excludeUserSites)`
`void`	`setOnlyIndexSearchToolSites(boolean onlyIndexSearchToolSites)`
`void`	`setSearchBuilderItemDao(SearchBuilderItemDao searchBuilderItemDao)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail