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

Class IndexResource

java.lang.Object

io.goobi.viewer.api.rest.v1.index.IndexResource

@Path("/index")
public class IndexResource
extends Object

REST resource providing search, field information, and statistical queries against the Solr index.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
IndexResource()

Method Summary

Modifier and Type	Method	Description
protected Collection<GeoMapFeature>	createFeatures(String query, String coordinateQuery, String labelConfig, String searchScope)
List<SolrFieldInfo>	getAllIndexFields()
String	getGeoJsonResuls(String solrField, String wktRegion, String filterQuery, String facetQuery, String labelField, String searchScope)
String	getHeatmap(String solrField, String wktRegion, String filterQuery, String facetQuery, Integer gridLevel)
String	getItemMetadataList(String config)
String	getMarkerMetadataList(String config)
String	getRecordsForQuery(RecordsRequestParameters params)
String	getStatistics(String query)
StreamingOutput	stream(String expression)

Methods inherited from class java.lang.Object

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

Constructor Details

IndexResource

public IndexResource()

Method Details

getStatistics

@GET
@Path("/statistics")
@Produces("application/json")
public String getStatistics(@QueryParam("query")
 String query)
                     throws IndexUnreachableException,
PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Parameters:

query - optional Solr query to filter counted records

Returns:

Indexed records statistics as JSON

Throws:

IndexUnreachableException

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getRecordsForQuery

@POST
@Path("/query")
@Consumes("application/json")
@Produces("application/json")
public String getRecordsForQuery(RecordsRequestParameters params)
                          throws IndexUnreachableException,
ViewerConfigurationException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Parameters:

params - query parameters including query, sort, facet, and result field configuration

Returns:

Records as JSON

Throws:

IndexUnreachableException

ViewerConfigurationException

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

stream

@POST
@Path("/stream")
@Consumes("text/plain")
@Produces("application/json")
public StreamingOutput stream(String expression)

Parameters:

expression - raw Solr streaming expression to execute

Returns:

StreamingOutput

getAllIndexFields

@GET
@Path("/fields")
@Produces("application/json")
public List<SolrFieldInfo> getAllIndexFields()
                                      throws IOException

Returns:

List

Throws:

IOException

getHeatmap

@GET
@Path("/spatial/heatmap/{solrField}")
@Produces("application/json")
public String getHeatmap(@PathParam("solrField")
 String solrField,
 @QueryParam("region") @DefaultValue("[\"-180 -90\" TO \"180 90\"]")
 String wktRegion,
 @QueryParam("query") @DefaultValue("*:*")
 String filterQuery,
 @QueryParam("facetQuery") @DefaultValue("")
 String facetQuery,
 @QueryParam("gridLevel")
 Integer gridLevel)
                  throws IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Parameters:

solrField - Solr field containing spatial coordinate data

wktRegion - WKT coordinate string restricting the search area

filterQuery - additional Solr query to filter results

facetQuery - facetting expression applied to heatmap results

gridLevel - heatmap grid resolution level

Returns:

Heatmap as String

Throws:

IOException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getGeoJsonResuls

@GET
@Path("/spatial/search/{solrField}")
@Produces("application/json")
public String getGeoJsonResuls(@PathParam("solrField")
 String solrField,
 @QueryParam("region") @DefaultValue("[\"-180 -90\" TO \"180 90\"]")
 String wktRegion,
 @QueryParam("query") @DefaultValue("*:*")
 String filterQuery,
 @QueryParam("facetQuery") @DefaultValue("")
 String facetQuery,
 @QueryParam("labelField")
 String labelField,
 @QueryParam("scope")
 String searchScope)
                        throws IndexUnreachableException,
PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

IndexUnreachableException

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

createFeatures

protected Collection<GeoMapFeature> createFeatures(String query,
 String coordinateQuery,
 String labelConfig,
 String searchScope)
                                            throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getMarkerMetadataList

public String getMarkerMetadataList(String config)

getItemMetadataList

public String getItemMetadataList(String config)