Package org.dspace.app.iiif.service

Class RangeService

java.lang.Object

org.dspace.app.iiif.service.AbstractResourceService

org.dspace.app.iiif.service.RangeService

@RequestScope
@Component
public class RangeService
extends AbstractResourceService

This service provides methods for creating a Range. 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
RangeService(org.dspace.services.ConfigurationService configurationService)

Method Summary

Modifier and Type	Method	Description
RangeGenerator	getRangeReference(RangeGenerator range)	Ranges expect the sub-range to have only an identifier.
RangeGenerator	getRootRange()	Get the root range generator.
Map<String,RangeGenerator>	getTocRanges()	Gets the current ranges.
void	setRootRange(String manifestId)	Sets the root range generator to which sub-ranges will be added.
void	updateRanges(Bitstream bitstream, String bundleToCPrefix, CanvasGenerator canvas)	Updates the current range and adds sub-ranges.

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

RangeService

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

Method Details

getRootRange

public RangeGenerator getRootRange()

Get the root range generator. This will contain table of contents entries.

Returns:

setRootRange

public void setRootRange(String manifestId)

Sets the root range generator to which sub-ranges will be added.

Parameters:

manifestId - id of the manifest to which ranges will be added.

getTocRanges

public Map<String,RangeGenerator> getTocRanges()

Gets the current ranges.

Returns:

map of toc ranges.

updateRanges

public void updateRanges(Bitstream bitstream,
 String bundleToCPrefix,
 CanvasGenerator canvas)

Updates the current range and adds sub-ranges.

Parameters:

bitstream - bitstream DSO

bundleToCPrefix - range prefix from bundle metadata

canvas - the current canvas generator

getRangeReference

public RangeGenerator getRangeReference(RangeGenerator range)

Ranges expect the sub-range to have only an identifier.

Parameters:

range - the sub-range to reference

Returns:

RangeGenerator able to create the reference