org.dspace.app.util

Class OpenSearchServiceImpl

java.lang.Object

org.dspace.app.util.OpenSearchServiceImpl

All Implemented Interfaces:

OpenSearchService, org.springframework.beans.factory.InitializingBean

public class OpenSearchServiceImpl
extends Object
implements OpenSearchService, org.springframework.beans.factory.InitializingBean

Utility Class with static methods for producing OpenSearch-compliant search results, and the OpenSearch description document.

OpenSearch is a specification for describing and advertising search-engines and their result formats. Commonly, RSS and Atom formats are used, which the current implementation supports, as is HTML (used directly in browsers). NB: this is baseline OpenSearch, no extensions currently supported.

The value of the "scope" parameter should either be absent (which means no scope restriction), or the handle of a community or collection.

Author:

Richard Rodgers

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled
protected List<String>	formats
protected HandleService	handleService
protected String	osNs
protected String	svcUrl
protected String	uiUrl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenSearchServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	getContentType(String format) Returns a mime-type associated with passed format
String	getDescription(String scope) Returns OpenSearch Servic Document as a string
Document	getDescriptionDoc(String scope) Returns the OpenSearch service document appropriate for given scope
List<String>	getFormats() Returns list of supported formats
protected SyndicationFeed	getResults(Context context, String format, String query, int totalResults, int start, int pageSize, DSpaceObject scope, DSpaceObject[] results, Map<String,String> labels)
Document	getResultsDoc(Context context, String format, String query, int totalResults, int start, int pageSize, DSpaceObject scope, DSpaceObject[] results, Map<String,String> labels) Returns a formatted set of search results as a document
String	getResultsString(Context context, String format, String query, int totalResults, int start, int pageSize, DSpaceObject scope, DSpaceObject[] results, Map<String,String> labels) Returns a formatted set of search results as a string
protected org.jdom.Document	getServiceDocument(String scope) Returns as a document the OpenSearch service document
protected Document	jDomToW3(org.jdom.Document jdomDoc) Converts a JDOM document to a W3C one
protected com.sun.syndication.feed.module.opensearch.OpenSearchModule	openSearchMarkup(String query, int totalResults, int start, int pageSize)
DSpaceObject	resolveScope(Context context, String scope)

Methods inherited from class java.lang.Object

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

Field Detail

enabled

protected boolean enabled

formats

protected List<String> formats

osNs

protected final String osNs

See Also:

Constant Field Values

uiUrl

protected String uiUrl

svcUrl

protected String svcUrl

handleService

@Autowired(required=true)
protected HandleService handleService

Constructor Detail

OpenSearchServiceImpl

protected OpenSearchServiceImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getFormats

public List<String> getFormats()

Description copied from interface: OpenSearchService

Returns list of supported formats

Specified by:

getFormats in interface OpenSearchService

Returns:

list of format names - 'rss', 'atom' or 'html'

getContentType

public String getContentType(String format)

Description copied from interface: OpenSearchService

Returns a mime-type associated with passed format

Specified by:

getContentType in interface OpenSearchService

Parameters:

format - the results document format (rss, atom, html)

Returns:

content-type mime-type

getDescriptionDoc

public Document getDescriptionDoc(String scope)
                           throws IOException

Description copied from interface: OpenSearchService

Returns the OpenSearch service document appropriate for given scope

Specified by:

getDescriptionDoc in interface OpenSearchService

Parameters:

scope - - null for entire repository, or handle or community or collection

Returns:

document the service document

Throws:

IOException

getDescription

public String getDescription(String scope)

Description copied from interface: OpenSearchService

Returns OpenSearch Servic Document as a string

Specified by:

getDescription in interface OpenSearchService

Parameters:

scope - - null for entire repository, or handle or community or collection

Returns:

service document as a string

getResultsString

public String getResultsString(Context context,
                      String format,
                      String query,
                      int totalResults,
                      int start,
                      int pageSize,
                      DSpaceObject scope,
                      DSpaceObject[] results,
                      Map<String,String> labels)
                        throws IOException

Description copied from interface: OpenSearchService

Returns a formatted set of search results as a string

Specified by:

getResultsString in interface OpenSearchService

format - results format - html, rss or atom

query - - the search query

totalResults - - the hit count

start - - start result index

pageSize - - page size

scope - - search scope, null or community/collection handle

results - the retreived DSpace objects satisfying search

labels - labels to apply - format specific

Returns:

formatted search results

Throws:

IOException

getResultsDoc

public Document getResultsDoc(Context context,
                     String format,
                     String query,
                     int totalResults,
                     int start,
                     int pageSize,
                     DSpaceObject scope,
                     DSpaceObject[] results,
                     Map<String,String> labels)
                       throws IOException

Description copied from interface: OpenSearchService

Returns a formatted set of search results as a document

Specified by:

getResultsDoc in interface OpenSearchService

format - results format - html, rss or atom

query - - the search query

totalResults - - the hit count

start - - start result index

pageSize - - page size

scope - - search scope, null or community/collection handle

results - the retreived DSpace objects satisfying search

labels - labels to apply - format specific

Returns:

formatted search results

Throws:

IOException

getResults

protected SyndicationFeed getResults(Context context,
                         String format,
                         String query,
                         int totalResults,
                         int start,
                         int pageSize,
                         DSpaceObject scope,
                         DSpaceObject[] results,
                         Map<String,String> labels)

openSearchMarkup

protected com.sun.syndication.feed.module.opensearch.OpenSearchModule openSearchMarkup(String query,
                                                                           int totalResults,
                                                                           int start,
                                                                           int pageSize)

getServiceDocument

protected org.jdom.Document getServiceDocument(String scope)

Returns as a document the OpenSearch service document

Parameters:

scope - - null for the entire repository, or a collection/community handle

Returns:

Service Document

jDomToW3

protected Document jDomToW3(org.jdom.Document jdomDoc)
                     throws IOException

Converts a JDOM document to a W3C one

Parameters:

jdomDoc -

Returns:

W3C Document object

Throws:

IOException

resolveScope

public DSpaceObject resolveScope(Context context,
                        String scope)
                          throws SQLException

Specified by:

resolveScope in interface OpenSearchService

Throws:

SQLException