org.sakaiproject.search.entitybroker

Class SearchEntityProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.search.entitybroker.SearchEntityProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.Formats, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class SearchEntityProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable

Entity provider for Entity broker giving access to search services through a an HTTP method

Author:

Adrian Fish (a.fish@lancaster.ac.uk), Colin Hebert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SearchEntityProvider.SearchResultEntity A wrapper to customise the result sent through EntityBroker Wraps a SearchResult to avoid issues with the SearchResult.getId() method and EntityReference.checkPrefixId(String, String).

Field Summary

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
SearchEntityProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntityPrefix() Name of the service, here "search"
String[]	getHandledOutputFormats() Handled formats, such as JSon and XML
Set<String>	getTools() Get the list of tools handled by the search engine.
List<SearchEntityProvider.SearchResultEntity>	search(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search) Simple search method
void	setSearchIndexBuilder(org.sakaiproject.search.api.SearchIndexBuilder searchIndexBuilder)
void	setSearchService(org.sakaiproject.search.api.SearchService searchService)
void	setSiteService(org.sakaiproject.site.api.SiteService siteService)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEntityProvider

public SearchEntityProvider()

Method Detail

getEntityPrefix

public String getEntityPrefix()

Name of the service, here "search"

Specified by:

getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

Returns:

the constant name of this service

getHandledOutputFormats

public String[] getHandledOutputFormats()

Handled formats, such as JSon and XML

Specified by:

getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

Returns:

formats supported

search

public List<SearchEntityProvider.SearchResultEntity> search(org.sakaiproject.entitybroker.EntityReference ref,
                                                   org.sakaiproject.entitybroker.entityprovider.search.Search search)

Simple search method

Parameters:

ref -

search -

Returns:

a list of SearchResults

getTools

public Set<String> getTools()

Get the list of tools handled by the search engine.

Returns:

a list of supported tools

setSearchService

public void setSearchService(org.sakaiproject.search.api.SearchService searchService)

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

setUserDirectoryService

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

setSearchIndexBuilder

public void setSearchIndexBuilder(org.sakaiproject.search.api.SearchIndexBuilder searchIndexBuilder)