org.sakaiproject.search.adapter

Class SearchServiceAdapter

java.lang.Object

org.sakaiproject.search.adapter.SearchServiceAdapter

All Implemented Interfaces:

org.sakaiproject.search.api.Diagnosable, org.sakaiproject.search.api.SearchService

public class SearchServiceAdapter
extends Object
implements org.sakaiproject.search.api.SearchService

Adapter allowing to easily switch the search implementation with a configuration in sakai.properties.

Author:

Colin Hebert

Field Summary

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_DIGEST_COUNT, FIELD_REFERENCE, FIELD_SITEID, FIELD_TITLE, FIELD_TOOL, FIELD_TYPE, FIELD_URL, REST_CHECKSUM, REST_CONTEXTS, REST_END, REST_START, REST_TERMS, REST_USERID

Constructor Summary

Constructors

Constructor and Description
SearchServiceAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	disableDiagnostics()
void	enableDiagnostics()
void	forceReload()
List<org.sakaiproject.search.model.SearchBuilderItem>	getAllSearchItems()
String	getDigestStoragePath()
List<org.sakaiproject.search.model.SearchBuilderItem>	getGlobalMasterSearchItems()
int	getNDocs()
int	getPendingDocs()
org.sakaiproject.search.api.SearchStatus	getSearchStatus()
String	getSearchSuggestion(String searchString)
String[]	getSearchSuggestions(String searchString, String currentSite, boolean allMySites)
List	getSegmentInfo()
List<org.sakaiproject.search.model.SearchBuilderItem>	getSiteMasterSearchItems()
String	getStatus()
org.sakaiproject.search.api.TermFrequency	getTerms(int documentId)
boolean	hasDiagnostics()
boolean	isEnabled()
boolean	isSearchServer()
void	rebuildInstance()
void	rebuildSite(String currentSiteId)
void	refreshInstance()
void	refreshSite(String currentSiteId)
void	registerFunction(String function)
void	reload()
boolean	removeWorkerLock()
org.sakaiproject.search.api.SearchList	search(String searchTerms, List<String> contexts, int searchStart, int searchEnd)
org.sakaiproject.search.api.SearchList	search(String searchTerms, List<String> contexts, int start, int end, String filterName, String sorterName)
String	searchXML(Map parameterMap)
void	setSearchServer(boolean searchServer) provides some backwards compatibility for impls that doesn't support setting this property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchServiceAdapter

public SearchServiceAdapter()

Method Detail

search

public org.sakaiproject.search.api.SearchList search(String searchTerms,
                                            List<String> contexts,
                                            int searchStart,
                                            int searchEnd)
                                              throws org.sakaiproject.search.api.InvalidSearchQueryException

Specified by:

search in interface org.sakaiproject.search.api.SearchService

Throws:

org.sakaiproject.search.api.InvalidSearchQueryException

search

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

Specified by:

search in interface org.sakaiproject.search.api.SearchService

Throws:

org.sakaiproject.search.api.InvalidSearchQueryException

registerFunction

public void registerFunction(String function)

Specified by:

registerFunction in interface org.sakaiproject.search.api.SearchService

reload

public void reload()

Specified by:

reload in interface org.sakaiproject.search.api.SearchService

refreshInstance

public void refreshInstance()

Specified by:

refreshInstance in interface org.sakaiproject.search.api.SearchService

rebuildInstance

public void rebuildInstance()

Specified by:

rebuildInstance in interface org.sakaiproject.search.api.SearchService

refreshSite

public void refreshSite(String currentSiteId)

Specified by:

refreshSite in interface org.sakaiproject.search.api.SearchService

rebuildSite

public void rebuildSite(String currentSiteId)

Specified by:

rebuildSite in interface org.sakaiproject.search.api.SearchService

getStatus

public String getStatus()

Specified by:

getStatus in interface org.sakaiproject.search.api.SearchService

getNDocs

public int getNDocs()

Specified by:

getNDocs in interface org.sakaiproject.search.api.SearchService

getPendingDocs

public int getPendingDocs()

Specified by:

getPendingDocs in interface org.sakaiproject.search.api.SearchService

getAllSearchItems

public List<org.sakaiproject.search.model.SearchBuilderItem> getAllSearchItems()

Specified by:

getAllSearchItems in interface org.sakaiproject.search.api.SearchService

getSiteMasterSearchItems

public List<org.sakaiproject.search.model.SearchBuilderItem> getSiteMasterSearchItems()

Specified by:

getSiteMasterSearchItems in interface org.sakaiproject.search.api.SearchService

getGlobalMasterSearchItems

public List<org.sakaiproject.search.model.SearchBuilderItem> getGlobalMasterSearchItems()

Specified by:

getGlobalMasterSearchItems in interface org.sakaiproject.search.api.SearchService

getSearchStatus

public org.sakaiproject.search.api.SearchStatus getSearchStatus()

Specified by:

getSearchStatus in interface org.sakaiproject.search.api.SearchService

removeWorkerLock

public boolean removeWorkerLock()

Specified by:

removeWorkerLock in interface org.sakaiproject.search.api.SearchService

getSegmentInfo

public List getSegmentInfo()

Specified by:

getSegmentInfo in interface org.sakaiproject.search.api.SearchService

forceReload

public void forceReload()

Specified by:

forceReload in interface org.sakaiproject.search.api.SearchService

getTerms

public org.sakaiproject.search.api.TermFrequency getTerms(int documentId)
                                                   throws IOException

Specified by:

getTerms in interface org.sakaiproject.search.api.SearchService

Throws:

IOException

searchXML

public String searchXML(Map parameterMap)

Specified by:

searchXML in interface org.sakaiproject.search.api.SearchService

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.sakaiproject.search.api.SearchService

getDigestStoragePath

public String getDigestStoragePath()

Specified by:

getDigestStoragePath in interface org.sakaiproject.search.api.SearchService

getSearchSuggestion

public String getSearchSuggestion(String searchString)

Specified by:

getSearchSuggestion in interface org.sakaiproject.search.api.SearchService

getSearchSuggestions

public String[] getSearchSuggestions(String searchString,
                            String currentSite,
                            boolean allMySites)

Specified by:

getSearchSuggestions in interface org.sakaiproject.search.api.SearchService

setSearchServer

public void setSearchServer(boolean searchServer)

provides some backwards compatibility for impls that doesn't support setting this property.

Parameters:

searchServer -

isSearchServer

public boolean isSearchServer()

Specified by:

isSearchServer in interface org.sakaiproject.search.api.SearchService

enableDiagnostics

public void enableDiagnostics()

Specified by:

enableDiagnostics in interface org.sakaiproject.search.api.Diagnosable

disableDiagnostics

public void disableDiagnostics()

Specified by:

disableDiagnostics in interface org.sakaiproject.search.api.Diagnosable

hasDiagnostics

public boolean hasDiagnostics()

Specified by:

hasDiagnostics in interface org.sakaiproject.search.api.Diagnosable