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

Class RecordPageResource

java.lang.Object

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

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

Author:

florian

Constructor Summary

Constructors

Constructor	Description
RecordPageResource(jakarta.servlet.http.HttpServletRequest request, String pi)

Method Summary

Modifier and Type	Method	Description
de.intranda.api.annotation.IAnnotationCollection	getAnnotationsForRecord(Integer pageNo)
de.intranda.api.iiif.presentation.IPresentationModelElement	getCanvas(Integer pageNo)
de.intranda.api.annotation.IAnnotationCollection	getCommentsForPage(Integer pageNo)
de.intranda.api.iiif.presentation.IPresentationModelElement	getManifest(Integer pageNo, String mode)
DocumentReference	getNERTags(Integer pageNo, String type)
de.intranda.api.iiif.presentation.IPresentationModelElement	getSequence(String mode, String preferedView)
de.intranda.api.annotation.IAnnotationCollection	getTextForPage(Integer pageNo, String format)

Methods inherited from class java.lang.Object

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

Constructor Details

RecordPageResource

public RecordPageResource(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @PathParam("pi")
 String pi)

Method Details

getNERTags

@GET
@Path("/{pageNo}/ner/tags")
@Produces("application/json")
public DocumentReference getNERTags(@PathParam("pageNo")
 Integer pageNo,
 @QueryParam("type")
 String type)
                             throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getSequence

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

Throws:

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

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

DAOException

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

getManifest

@GET
@Path("/{pageNo}/manifest")
@Produces("application/json")
public de.intranda.api.iiif.presentation.IPresentationModelElement getManifest(@PathParam("pageNo")
 Integer pageNo,
 @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

getCanvas

@GET
@Path("/{pageNo}/canvas")
@Produces("application/json")
public de.intranda.api.iiif.presentation.IPresentationModelElement getCanvas(@PathParam("pageNo")
 Integer pageNo)
                                                                      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

getAnnotationsForRecord

@GET
@Path("/{pageNo}/annotations")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotationCollection getAnnotationsForRecord(@PathParam("pageNo")
 Integer pageNo)
                                                                         throws DAOException

Throws:

DAOException

getCommentsForPage

@GET
@Path("/{pageNo}/comments")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotationCollection getCommentsForPage(@PathParam("pageNo")
 Integer pageNo)
                                                                    throws DAOException

Throws:

DAOException

getTextForPage

@GET
@Path("/{pageNo}/text")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotationCollection getTextForPage(@PathParam("pageNo")
 Integer pageNo,
 @QueryParam("format")
 String format)
                                                                throws URISyntaxException,
DAOException,
PresentationException,
IndexUnreachableException,
ViewerConfigurationException

Throws:

URISyntaxException

DAOException

PresentationException

IndexUnreachableException

ViewerConfigurationException