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

Class RecordResource

java.lang.Object

io.goobi.viewer.api.rest.v1.records.RecordResource

@Path("/records/{pi}")
public class RecordResource
extends Object

REST resource providing record metadata, IIIF manifests, full-text, and various export formats for digitized records.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
RecordResource(HttpServletRequest request, String pi)

Method Summary

Modifier and Type	Method	Description
de.intranda.api.iiif.search.AutoSuggestResult	autoCompleteInManifest(String pi, String query, String motivation, String date, String user, Integer page)	autoCompleteInManifest.
String	deleteRecord(Boolean createTraceDocument)	deleteRecord.
String	getAlto()
StreamingOutput	getAltoAsZip()
de.intranda.api.annotation.IAnnotationCollection	getAnnotationsForRecord(String format)
static BuildMode	getBuildeMode(String mode)
String	getCmdiLanguage(String language)
de.intranda.api.annotation.wa.collection.AnnotationPage	getCommentPageForRecord(Integer page)
de.intranda.api.annotation.IAnnotationCollection	getCommentsForRecord(String format)
de.intranda.api.iiif.presentation.IPresentationModelElement	getLayer(String layerName, String mode)
de.intranda.api.iiif.presentation.IPresentationModelElement	getManifest(String mode)
DocumentReference	getNERTags(Integer start, Integer end, Integer stepSize, String type)
String	getPlaintext()
StreamingOutput	getPlaintextAsZip()
Response	getRecordMetadataAsJson(String pi, String template)
String	getRISAsFile()
String	getRISAsText()	getRISAsText.
StreamingOutput	getSource()
String	getTei()
StreamingOutput	getTeiAsZip(String language)
String	getTeiLanguage(String language)
String	getTOCAsText()
de.intranda.api.iiif.search.SearchResult	searchInManifest(String pi, String query, String motivation, String date, String user, Integer page)	Endpoint for IIIF Search API service in a manifest.

Methods inherited from class java.lang.Object

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

Constructor Details

RecordResource

public RecordResource(@Context
 HttpServletRequest request,
 @PathParam("pi")
 String pi)

Method Details

getRISAsFile

@GET
@Path("/ris")
@Produces("text/plain")
public String getRISAsFile()
                    throws PresentationException,
IndexUnreachableException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

DAOException

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

getRISAsText

@GET
@Path("/ris.txt")
@Produces("text/plain")
public String getRISAsText()
                    throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
DAOException

getRISAsText.

Returns:

the RIS citation for the record as plain text

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - if any.

DAOException - if any.

getTOCAsText

@GET
@Path("/toc")
@Produces("text/plain")
public String getTOCAsText()
                    throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
DAOException,
ViewerConfigurationException

Throws:

PresentationException

IndexUnreachableException

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

DAOException

ViewerConfigurationException

getAnnotationsForRecord

@GET
@Path("/annotations")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotationCollection getAnnotationsForRecord(@QueryParam("format")
 String format)
                                                                         throws DAOException

Throws:

DAOException

getCommentsForRecord

@GET
@Path("/comments")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotationCollection getCommentsForRecord(@QueryParam("format")
 String format)
                                                                      throws DAOException

Throws:

DAOException

getCommentPageForRecord

@GET
@Path("/comments/{page}")
@Produces("application/json")
public de.intranda.api.annotation.wa.collection.AnnotationPage getCommentPageForRecord(@PathParam("page")
 Integer page)
                                                                                throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

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

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

getSource

@GET
@Path("/metadata/source")
@Produces("text/xml")
public StreamingOutput getSource()
                          throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
PresentationException,
IndexUnreachableException

Throws:

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

PresentationException

IndexUnreachableException

getManifest

@GET
@Path("/manifest")
@Produces("application/json")
public de.intranda.api.iiif.presentation.IPresentationModelElement getManifest(@QueryParam("mode")
 String mode)
                                                                        throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
DAOException

Throws:

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

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

DAOException

getLayer

@GET
@Path("/layers/{name}")
@Produces("application/json")
public de.intranda.api.iiif.presentation.IPresentationModelElement getLayer(@PathParam("name")
 String layerName,
 @QueryParam("mode")
 String mode)
                                                                     throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
IOException

Throws:

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

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

DAOException

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

IOException

getNERTags

@GET
@Path("/ner/tags")
@Produces("application/json")
public DocumentReference getNERTags(@QueryParam("start")
 Integer start,
 @QueryParam("end")
 Integer end,
 @QueryParam("step")
 Integer stepSize,
 @QueryParam("type")
 String type)
                             throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getPlaintext

@GET
@Path("/plaintext")
@Produces("text/plain")
public String getPlaintext()
                    throws PresentationException,
IndexUnreachableException,
IOException

Throws:

PresentationException

IndexUnreachableException

IOException

getPlaintextAsZip

@GET
@Path("/plaintext.zip")
@Produces("application/zip")
public StreamingOutput getPlaintextAsZip()
                                  throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getAlto

@GET
@Path("/alto")
@Produces("text/xml")
public String getAlto()
               throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getAltoAsZip

@GET
@Path("/alto.zip")
@Produces("application/zip")
public StreamingOutput getAltoAsZip()
                             throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getCmdiLanguage

@GET
@Path("/cmdi/{lang}")
@Produces("text/xml")
public String getCmdiLanguage(@PathParam("lang")
 String language)
                       throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getTeiLanguage

@GET
@Path("/tei/{lang}")
@Produces("text/xml")
public String getTeiLanguage(@PathParam("lang")
 String language)
                      throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getTei

@GET
@Path("/tei")
@Produces("text/xml")
public String getTei()
              throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

getTeiAsZip

@GET
@Path("/tei.zip")
@Produces("application/zip")
public StreamingOutput getTeiAsZip(@QueryParam("lang")
 String language)
                            throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IndexUnreachableException

IOException

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

searchInManifest

@GET
@Path("/manifest/search")
@Produces("application/json")
public de.intranda.api.iiif.search.SearchResult searchInManifest(@PathParam("pi")
 String pi,
 @QueryParam("q")
 String query,
 @QueryParam("motivation")
 String motivation,
 @QueryParam("date")
 String date,
 @QueryParam("user")
 String user,
 @QueryParam("page")
 Integer page)
                                                          throws IndexUnreachableException,
PresentationException

Endpoint for IIIF Search API service in a manifest. Depending on the given motivation parameters, fulltext (motivation=painting), user comments (motivation=commenting) and general (crowdsourcing-) annotations (motivation=describing) may be searched.

Parameters:

pi - The pi of the manifest to search

query - The search query; a list of space separated terms. The search is for all complete words which match any of the query terms. Terms may contain the wildcard character '*' to represent an arbitrary number of characters within the word

motivation - a space separated list of motivations of annotations to search for. Search for the following motivations is implemented:

• painting: fulltext resources
• non-painting: all supported resources except fulltext
• commenting: user comments
• describing: Crowdsourced or other general annotations

date - not supported. If this parameter is given, it will be included in the 'ignored' property of the 'within' property of the answer

user - not supported. If this parameter is given, it will be included in the 'ignored' property of the 'within' property of the answer

page - the page number for paged result sets. if this is empty, page=1 is assumed

Returns:

a SearchResult containing all annotations matching the query in the 'resources' property

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

autoCompleteInManifest

@GET
@Path("/manifest/autocomplete")
@Produces("application/json")
public de.intranda.api.iiif.search.AutoSuggestResult autoCompleteInManifest(@PathParam("pi")
 String pi,
 @QueryParam("q")
 String query,
 @QueryParam("motivation")
 String motivation,
 @QueryParam("date")
 String date,
 @QueryParam("user")
 String user,
 @QueryParam("page")
 Integer page)
                                                                     throws IndexUnreachableException,
PresentationException

autoCompleteInManifest.

Parameters:

pi - persistent identifier of the record to search

query - partial query string for auto-completion

motivation - space-separated list of annotation motivations to filter

date - date filter (not supported; passed to 'ignored' property)

user - user filter (not supported; passed to 'ignored' property)

page - result page number; defaults to 1 if absent

Returns:

the IIIF AutoSuggest result containing auto-completion candidates for the given query

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getBuildeMode

public static BuildMode getBuildeMode(String mode)

Parameters:

mode - build mode string (e.g. "simple", "thumbs", "iiif")

Returns:

BuildMode

deleteRecord

@DELETE
@Produces("application/json")
@Consumes("application/json")
public String deleteRecord(@QueryParam("trace")
 Boolean createTraceDocument)

deleteRecord.

Parameters:

createTraceDocument - if true, a trace document is written after deletion

Returns:

Short summary of files deleted

getRecordMetadataAsJson

@GET
@Path("/json/{template}")
@Produces("application/json")
public Response getRecordMetadataAsJson(@PathParam("pi")
 String pi,
 @PathParam("template")
 String template)
                                 throws IndexUnreachableException,
PresentationException

Parameters:

pi - Record identifier

template - JSON configuration template name

Returns:

Response

Throws:

IndexUnreachableException

PresentationException