Package org.dspace.app.iiif.service

Class SequenceService

java.lang.Object

org.dspace.app.iiif.service.AbstractResourceService

org.dspace.app.iiif.service.SequenceService

@RequestScope
@Component
public class SequenceService
extends AbstractResourceService

This service provides methods for creating a Sequence. There should be a single instance of this service per request. The @RequestScope provides a single instance created and available during complete lifecycle of the HTTP request.

Author:

Michael Spalti mspalti@willamette.edu, Andrea Bollini (andrea.bollini at 4science.it)

Field Summary

Fields inherited from class org.dspace.app.iiif.service.AbstractResourceService

BITSTREAM_PATH_PREFIX, CLIENT_URL, DEFAULT_CANVAS_HEIGHT, DEFAULT_CANVAS_WIDTH, defaultCanvasHeightFallback, defaultCanvasWidthFallback, DOCUMENT_VIEWING_HINT, IIIF_ENDPOINT, IIIF_LOGO_IMAGE, IMAGE_PATH, IMAGE_SERVICE, SEARCH_URL, THUMBNAIL_PATH

Constructor Summary

Constructors

Constructor	Description
SequenceService(org.dspace.services.ConfigurationService configurationService)

Method Summary

Modifier and Type	Method	Description
CanvasGenerator	addCanvas(Context context, Item item, Bundle bnd, Bitstream bitstream)	This method adds a canvas to the sequence for each item in the list of DSpace bitstreams.
CanvasItemsGenerator	getSequence(Item item)	Returns a sequence generator that has been configured with canvases.

Methods inherited from class org.dspace.app.iiif.service.AbstractResourceService

getManifestId, setConfiguration, setDefaultCanvasDimensions

Methods inherited from class java.lang.Object

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

Constructor Details

SequenceService

public SequenceService(org.dspace.services.ConfigurationService configurationService)

Method Details

getSequence

public CanvasItemsGenerator getSequence(Item item)

Returns a sequence generator that has been configured with canvases. (@abollini will update.)

Parameters:

item - the DSpace item

Returns:

a sequence generator

addCanvas

public CanvasGenerator addCanvas(Context context,
 Item item,
 Bundle bnd,
 Bitstream bitstream)

This method adds a canvas to the sequence for each item in the list of DSpace bitstreams. Bitstreams must be on image mime type. (@abollini will update.)

Parameters:

context - the DSpace context

item - the DSpace Item

bnd - a DSpace bundle

bitstream - a DSpace bitstream