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

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

All Implemented Interfaces:

Diagnosable, SearchService

Direct Known Subclasses:

ConcurrentSearchServiceImpl, SearchServiceImpl

public abstract class BaseSearchServiceImpl
extends Object
implements SearchService

The search service

Author:

ieb

Field Summary

protected boolean	autoDdl Configuration: to run the ddl on init or not.
protected IndexStorage	indexStorage
protected boolean	initComplete init completed

Fields inherited from interface org.sakaiproject.search.api.SearchService

DATE_STAMP, EVENT_SEARCH, EVENT_SEARCH_REF, EVENT_TRIGGER_INDEX_RELOAD, EVENT_TRIGGER_SEARCH, FIELD_CONTAINER, FIELD_CONTENTS, FIELD_CONTEXT, FIELD_DIGEST_COUNT, FIELD_ID, FIELD_REFERENCE, FIELD_SITEID, FIELD_SUBTYPE, FIELD_TITLE, FIELD_TOOL, FIELD_TYPE, FIELD_URL, REST_CHECKSUM, REST_CONTEXTS, REST_END, REST_START, REST_TERMS, REST_USERID

Constructor Summary

BaseSearchServiceImpl()

Method Summary

void	disableDiagnostics()
void	enableDiagnostics()
void	forceReload()
List<SearchBuilderItem>	getAllSearchItems()
protected org.apache.lucene.analysis.Analyzer	getAnalyzer()
String	getAutoDdl()
String	getDefaultFilter()
String	getDefaultSorter()
boolean	getDiagnostics()
String	getDigestStoragePath()
org.sakaiproject.event.api.EventTrackingService	getEventTrackingService()
SearchItemFilter	getFilter()
List<SearchBuilderItem>	getGlobalMasterSearchItems()
org.apache.lucene.search.IndexSearcher	getIndexSearcher(boolean reload) The sequence is, peform reload,
IndexStorage	getIndexStorage()
Map	getLuceneFilters()
Map	getLuceneSorters()
int	getNDocs()
org.sakaiproject.event.api.NotificationService	getNotificationService()
int	getPendingDocs()
SearchIndexBuilder	getSearchIndexBuilder()
String	getSearchServerUrl()
abstract SearchStatus	getSearchStatus()
String	getSearchSuggestion(String queryString)
List	getSegmentInfo()
org.sakaiproject.tool.api.SessionManager	getSessionManager()
String	getSharedKey()
List<SearchBuilderItem>	getSiteMasterSearchItems()
abstract String	getStatus()
TermFrequency	getTerms(int documentId)
List<String>	getTriggerFunctions()
org.sakaiproject.user.api.UserDirectoryService	getUserDirectoryService()
boolean	hasDiagnostics()
void	init() Register a notification action to listen to events and modify the search index
boolean	isEnabled()
boolean	isSearchServer()
void	rebuildInstance()
void	rebuildSite(String currentSiteId)
void	refreshInstance()
void	refreshSite(String currentSiteId)
void	registerFunction(String function)
void	reload()
abstract boolean	removeWorkerLock()
SearchList	search(String searchTerms, List<String> contexts, int start, int end)
SearchList	search(String searchTerms, List<String> contexts, int start, int end, String filterName, String sorterName)
String	searchXML(Map parameterMap)
void	setAutoDdl(String value) Configuration: to run the ddl on init or not.
void	setDefaultFilter(String defaultFilter)
void	setDefaultSorter(String defaultSorter)
void	setDiagnostics(boolean diagnostics)
void	setEventTrackingService(org.sakaiproject.event.api.EventTrackingService eventTrackingService)
void	setFilter(SearchItemFilter filter)
void	setIndexStorage(IndexStorage indexStorage)
void	setJournalSettings(JournalSettings journalSettings)
void	setLuceneFilters(Map luceneFilters)
void	setLuceneSorters(Map luceneSorters)
void	setNotificationService(org.sakaiproject.event.api.NotificationService notificationService)
void	setSearchIndexBuilder(SearchIndexBuilder searchIndexBuilder)
void	setSearchServer(boolean searchServer)
void	setSearchServerUrl(String searchServerUrl)
void	setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)
void	setSharedKey(String sharedKey)
void	setTriggerFunctions(List<String> triggerFunctions)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

indexStorage

protected IndexStorage indexStorage

initComplete

protected boolean initComplete

init completed

autoDdl

protected boolean autoDdl

Configuration: to run the ddl on init or not.

Constructor Detail

BaseSearchServiceImpl

public BaseSearchServiceImpl()

Method Detail

setJournalSettings

public void setJournalSettings(JournalSettings journalSettings)

getStatus

public abstract String getStatus()

Specified by:

getStatus in interface SearchService

getSearchStatus

public abstract SearchStatus getSearchStatus()

Specified by:

getSearchStatus in interface SearchService

removeWorkerLock

public abstract boolean removeWorkerLock()

Specified by:

removeWorkerLock in interface SearchService

setAutoDdl

public void setAutoDdl(String value)

Configuration: to run the ddl on init or not.

Parameters:

value - the auto ddl value.

getAutoDdl

public String getAutoDdl()

init

public void init()

Register a notification action to listen to events and modify the search index

getTriggerFunctions

public List<String> getTriggerFunctions()

Returns:

Returns the triggerFunctions.

setTriggerFunctions

public void setTriggerFunctions(List<String> triggerFunctions)

Parameters:

triggerFunctions - The triggerFunctions to set.

registerFunction

public void registerFunction(String function)

Specified by:

registerFunction in interface SearchService

search

public SearchList search(String searchTerms,
                         List<String> contexts,
                         int start,
                         int end)
                  throws InvalidSearchQueryException

Specified by:

search in interface SearchService

Parameters:

indexFilter -

Throws:

InvalidSearchQueryException

search

public SearchList search(String searchTerms,
                         List<String> contexts,
                         int start,
                         int end,
                         String filterName,
                         String sorterName)
                  throws InvalidSearchQueryException

Specified by:

search in interface SearchService

Throws:

InvalidSearchQueryException

refreshInstance

public void refreshInstance()

Specified by:

refreshInstance in interface SearchService

rebuildInstance

public void rebuildInstance()

Specified by:

rebuildInstance in interface SearchService

refreshSite

public void refreshSite(String currentSiteId)

Specified by:

refreshSite in interface SearchService

rebuildSite

public void rebuildSite(String currentSiteId)

Specified by:

rebuildSite in interface SearchService

reload

public void reload()

Specified by:

reload in interface SearchService

forceReload

public void forceReload()

Specified by:

forceReload in interface SearchService

getIndexSearcher

public org.apache.lucene.search.IndexSearcher getIndexSearcher(boolean reload)

The sequence is, peform reload,

Parameters:

reload -

Returns:

getNDocs

public int getNDocs()

Specified by:

getNDocs in interface SearchService

getPendingDocs

public int getPendingDocs()

Specified by:

getPendingDocs in interface SearchService

getAllSearchItems

public List<SearchBuilderItem> getAllSearchItems()

Specified by:

getAllSearchItems in interface SearchService

getSiteMasterSearchItems

public List<SearchBuilderItem> getSiteMasterSearchItems()

Specified by:

getSiteMasterSearchItems in interface SearchService

getGlobalMasterSearchItems

public List<SearchBuilderItem> getGlobalMasterSearchItems()

Specified by:

getGlobalMasterSearchItems in interface SearchService

getFilter

public SearchItemFilter getFilter()

Returns:

Returns the filter.

setFilter

public void setFilter(SearchItemFilter filter)

Parameters:

filter - The filter to set.

getDefaultFilter

public String getDefaultFilter()

Returns:

Returns the defaultFilter.

setDefaultFilter

public void setDefaultFilter(String defaultFilter)

Parameters:

defaultFilter - The defaultFilter to set.

getDefaultSorter

public String getDefaultSorter()

Returns:

Returns the defaultSorter.

setDefaultSorter

public void setDefaultSorter(String defaultSorter)

Parameters:

defaultSorter - The defaultSorter to set.

getLuceneFilters

public Map getLuceneFilters()

Returns:

Returns the luceneFilters.

setLuceneFilters

public void setLuceneFilters(Map luceneFilters)

Parameters:

luceneFilters - The luceneFilters to set.

getLuceneSorters

public Map getLuceneSorters()

Returns:

Returns the luceneSorters.

setLuceneSorters

public void setLuceneSorters(Map luceneSorters)

Parameters:

luceneSorters - The luceneSorters to set.

getTerms

public TermFrequency getTerms(int documentId)
                       throws IOException

Specified by:

getTerms in interface SearchService

Throws:

IOException

searchXML

public String searchXML(Map parameterMap)

Specified by:

searchXML in interface SearchService

getSharedKey

public String getSharedKey()

Returns:

the sharedKey

setSharedKey

public void setSharedKey(String sharedKey)

Parameters:

sharedKey - the sharedKey to set

getSearchServerUrl

public String getSearchServerUrl()

Returns:

the searchServerUrl

setSearchServerUrl

public void setSearchServerUrl(String searchServerUrl)

Parameters:

searchServerUrl - the searchServerUrl to set

isSearchServer

public boolean isSearchServer()

Returns:

the searchServer

setSearchServer

public void setSearchServer(boolean searchServer)

Parameters:

searchServer - the searchServer to set

getDiagnostics

public boolean getDiagnostics()

setDiagnostics

public void setDiagnostics(boolean diagnostics)

getEventTrackingService

public org.sakaiproject.event.api.EventTrackingService getEventTrackingService()

Returns:

the eventTrackingService

setEventTrackingService

public void setEventTrackingService(org.sakaiproject.event.api.EventTrackingService eventTrackingService)

Parameters:

eventTrackingService - the eventTrackingService to set

getNotificationService

public org.sakaiproject.event.api.NotificationService getNotificationService()

Returns:

the notificationService

setNotificationService

public void setNotificationService(org.sakaiproject.event.api.NotificationService notificationService)

Parameters:

notificationService - the notificationService to set

getSearchIndexBuilder

public SearchIndexBuilder getSearchIndexBuilder()

Returns:

the searchIndexBuilder

setSearchIndexBuilder

public void setSearchIndexBuilder(SearchIndexBuilder searchIndexBuilder)

Parameters:

searchIndexBuilder - the searchIndexBuilder to set

getSessionManager

public org.sakaiproject.tool.api.SessionManager getSessionManager()

Returns:

the sessionManager

setSessionManager

public void setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)

Parameters:

sessionManager - the sessionManager to set

getUserDirectoryService

public org.sakaiproject.user.api.UserDirectoryService getUserDirectoryService()

Returns:

the userDirectoryService

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Parameters:

userDirectoryService - the userDirectoryService to set

getIndexStorage

public IndexStorage getIndexStorage()

Returns:

Returns the indexStorage.

setIndexStorage

public void setIndexStorage(IndexStorage indexStorage)

Parameters:

indexStorage - The indexStorage to set.

getAnalyzer

protected org.apache.lucene.analysis.Analyzer getAnalyzer()

disableDiagnostics

public void disableDiagnostics()

Specified by:

disableDiagnostics in interface Diagnosable

enableDiagnostics

public void enableDiagnostics()

Specified by:

enableDiagnostics in interface Diagnosable

hasDiagnostics

public boolean hasDiagnostics()

Specified by:

hasDiagnostics in interface Diagnosable

See Also:

Diagnosable.hasDiagnostics()

getSegmentInfo

public List getSegmentInfo()

Specified by:

getSegmentInfo in interface SearchService

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface SearchService

getDigestStoragePath

public String getDigestStoragePath()

Specified by:

getDigestStoragePath in interface SearchService

getSearchSuggestion

public String getSearchSuggestion(String queryString)

Specified by:

getSearchSuggestion in interface SearchService