Package org.mycore.restapi.v1

Class MCRRestAPISearch

java.lang.Object

org.mycore.restapi.v1.MCRRestAPISearch

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

Rest API methods that cover SOLR searches.

Version:

$Revision: $ $Date: $

Author:

Robert Stephan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORMAT_CSV
static final String	FORMAT_JSON
static final String	FORMAT_XML

Constructor Summary

Constructors

Constructor	Description
MCRRestAPISearch()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	search(jakarta.ws.rs.core.UriInfo info, jakarta.servlet.http.HttpServletRequest request, String query, String sort, String wt, String start, String rows, List<String> fq, List<String> fl, String facet, String facetSort, String facetLimit, List<String> facetFields, String facetMinCount, String jsonWrf)	see http://wiki.apache.org/solr/CommonQueryParameters for syntax of parameters

Methods inherited from class java.lang.Object

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

Field Details

FORMAT_JSON

public static final String FORMAT_JSON

See Also:

• Constant Field Values

FORMAT_XML

public static final String FORMAT_XML

See Also:

• Constant Field Values

FORMAT_CSV

public static final String FORMAT_CSV

See Also:

• Constant Field Values

Constructor Details

MCRRestAPISearch

public MCRRestAPISearch()

Method Details

search

@GET
@Produces({"text/xml;charset=UTF-8","application/json;charset=UTF-8","text/plain;charset=ISO-8859-1","text/plain;charset=UTF-8"})
public jakarta.ws.rs.core.Response search(@Context
 jakarta.ws.rs.core.UriInfo info,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @QueryParam("q")
 String query,
 @QueryParam("sort")
 String sort,
 @QueryParam("wt") @DefaultValue("xml")
 String wt,
 @QueryParam("start")
 String start,
 @QueryParam("rows")
 String rows,
 @QueryParam("fq")
 List<String> fq,
 @QueryParam("fl")
 List<String> fl,
 @QueryParam("facet")
 String facet,
 @QueryParam("facet.sort")
 String facetSort,
 @QueryParam("facet.limit")
 String facetLimit,
 @QueryParam("facet.field")
 List<String> facetFields,
 @QueryParam("facet.mincount")
 String facetMinCount,
 @QueryParam("json.wrf")
 String jsonWrf)
                                   throws MCRRestAPIException

see http://wiki.apache.org/solr/CommonQueryParameters for syntax of parameters

Parameters:

info - - the injected Jersey URIInfo object

request - - the injected HTTPServletRequest object

query - the Query in SOLR Query syntax

sort - the sort parameter - syntax as defined by SOLR

wt - the format parameter - syntax as defined by SOLR

start - the start parameter (number) - syntax as defined by SOLR

rows - the rows parameter (number) - syntax as defined by SOLR

fq - the filter query parameter - syntax as defined by SOLR

fl - the list of fields to be returned - syntax as defined by SOLR

facet - the facet parameter (true to return facets) - syntax as defined by SOLR

facetFields - the list of facetFields to be returned - syntax as defined by SOLR

jsonWrf - the name of the JSONP callback function - syntax as defined by SOLR

Returns:

a Jersey Response Object

Throws:

MCRRestAPIException