Package io.goobi.viewer.api.rest.v1.search

Class SearchResultResource

java.lang.Object

io.goobi.viewer.api.rest.v1.search.SearchResultResource

@Path("/search")
public class SearchResultResource
extends Object

REST resource for exporting search results in OpenSearch and RIS bibliographic formats.

Constructor Summary

Constructors

Constructor	Description
SearchResultResource()
SearchResultResource(HttpServletRequest servletRequest, HttpServletResponse servletResponse)

Method Summary

Modifier and Type	Method	Description
Response	getRISAsFile(String query, String sortString, String activeFacetString, int proximitySearchDistance)
Response	getSearchResultsAsFormat(String format, String query, String activeFacetString, int rows)	Generic export endpoint that transforms search results via a config-driven XSLT stylesheet.
Response	getSearchResultsAsXml(String query, String activeFacetString, int rows)	Exports the current search results as raw Solr-style XML.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResultResource

public SearchResultResource()

SearchResultResource

public SearchResultResource(HttpServletRequest servletRequest,
 HttpServletResponse servletResponse)

Method Details

getRISAsFile

@GET
@Path("/ris")
@Produces("text/plain")
public Response getRISAsFile(@QueryParam("query") @DefaultValue("")
 String query,
 @QueryParam("sortString") @DefaultValue("")
 String sortString,
 @QueryParam("activeFacetString") @DefaultValue("")
 String activeFacetString,
 @QueryParam("proximitySearchDistance") @DefaultValue("0")
 int proximitySearchDistance)
                      throws PresentationException,
IndexUnreachableException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
ViewerConfigurationException

Throws:

PresentationException

IndexUnreachableException

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

ViewerConfigurationException

getSearchResultsAsXml

@GET
@Path("/export/xml")
@Produces("application/xml")
public Response getSearchResultsAsXml(@QueryParam("query") @DefaultValue("*:*")
 String query,
 @QueryParam("activeFacetString") @DefaultValue("")
 String activeFacetString,
 @QueryParam("rows") @DefaultValue("100")
 int rows)
                               throws PresentationException,
IndexUnreachableException

Exports the current search results as raw Solr-style XML.

Parameters:

query - the Solr search query string

activeFacetString - the active facet filter string

rows - maximum number of results to return (default 100)

Returns:

a Response containing the Solr XML

Throws:

PresentationException - if the query cannot be parsed

IndexUnreachableException - if the Solr index is unreachable

getSearchResultsAsFormat

@GET
@Path("/export/{format}")
public Response getSearchResultsAsFormat(@PathParam("format")
 String format,
 @QueryParam("query") @DefaultValue("*:*")
 String query,
 @QueryParam("activeFacetString") @DefaultValue("")
 String activeFacetString,
 @QueryParam("rows") @DefaultValue("100")
 int rows)
                                  throws PresentationException,
IndexUnreachableException

Generic export endpoint that transforms search results via a config-driven XSLT stylesheet.

The format path parameter is matched against the name attribute of <format> elements in config_viewer.xml. If the format is not configured the endpoint returns 404; if it is configured but disabled it returns 403.

To add a new export format, simply add a <format> element to the configuration and drop the XSLT stylesheet into the viewer config directory or the classpath:

 <format name="marc" enabled="true" xslt="solr2marc.xsl"
         contentType="application/xml" fileExtension="xml" />
 

Parameters:

format - the export format name (e.g. "endnote", "bibtex", "ris")

query - the Solr search query string

activeFacetString - the active facet filter string

rows - maximum number of results to return (default 100)

Returns:

a Response with the transformed content

Throws:

PresentationException - if the query cannot be parsed

IndexUnreachableException - if the Solr index is unreachable