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

SearchResultResource class.

Constructor Summary

Constructors

Constructor	Description
SearchResultResource()

Method Summary

Modifier and Type	Method	Description
String	getRISAsFile(String query, String sortString, String activeFacetString, int proximitySearchDistance)
SearchHitChildList	getTagsForPageJson(String hitId, int numChildren)	getTagsForPageJson.
SearchHitChildList	getTagsForPageJson(String hitId, int numChildren, String resultGroupName)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResultResource

public SearchResultResource()

Method Details

getTagsForPageJson

@GET
@Path("/hit/{id}/{numChildren}")
@Produces("application/json")
public SearchHitChildList getTagsForPageJson(@PathParam("id")
 String hitId,
 @PathParam("numChildren")
 int numChildren)
                                      throws DAOException,
PresentationException,
IndexUnreachableException,
IOException,
ViewerConfigurationException

getTagsForPageJson.

Parameters:

hitId - a String object.

numChildren - a int.

Returns:

a io.goobi.viewer.servlets.rest.search.SearchHitChildList object.

Throws:

DAOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

IOException - if any.

ViewerConfigurationException - if any.

getTagsForPageJson

@GET
@Path("/hit/{id}/{numChildren}/{resultGroup}")
@Produces("application/json")
public SearchHitChildList getTagsForPageJson(@PathParam("id")
 String hitId,
 @PathParam("numChildren")
 int numChildren,
 @PathParam("resultGroup")
 String resultGroupName)
                                      throws DAOException,
PresentationException,
IndexUnreachableException,
IOException,
ViewerConfigurationException

Parameters:

hitId - IDDOC of the main search hit

numChildren - Number of child hits to load

resultGroupName - Requested result group name

Returns:

SearchHitChildList

Throws:

DAOException

PresentationException

IndexUnreachableException

IOException

ViewerConfigurationException

getRISAsFile

@GET
@Path("/ris")
@Produces("text/plain")
public String getRISAsFile(@PathParam("query")
 String query,
 @PathParam("sortString")
 String sortString,
 @PathParam("activeFacetString")
 String activeFacetString,
 @PathParam("proximitySearchDistance")
 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