de.digitalcollections.iiif.presentation.model.api.v2

Interface Sequence

All Superinterfaces:

IiifResource

public interface Sequence
extends IiifResource

Recommended URI Pattern: {scheme}://{host}/{prefix}/{identifier}/sequence/{name}

• Each sequence must have at least one canvas and is likely to have more than one.
• A manifest, sequence or canvas must not have a format.
• A manifest or sequence must not have a height.
• A manifest or sequence must not have a width.

Method Summary

Modifier and Type	Method and Description
List<Canvas>	getCanvases()
PropertyValue	getDescription()
PropertyValue	getLabel()
List<Metadata>	getMetadata()
String	getStartCanvas()
Thumbnail	getThumbnail()
String	getViewingDirection()
String	getViewingHint()
void	setCanvases(List<Canvas> canvases)
void	setDescription(PropertyValue description)
void	setId(URI id)
void	setLabel(PropertyValue label)
void	setMetadata(List<Metadata> metadata)
void	setStartCanvas(String startCanvas)
void	setThumbnail(Thumbnail thumbnail)
void	setViewingDirection(String viewingDirection)
void	setViewingHint(String viewingHint)

Methods inherited from interface de.digitalcollections.iiif.presentation.model.api.v2.IiifResource

getAttribution, getId, getLicense, getLogo, getRelated, getSeeAlso, getService, getType, getWithin, setAttribution, setId, setLicense, setLogo, setRelated, setSeeAlso, setService, setWithin

Method Detail

getCanvases

List<Canvas> getCanvases()

setCanvases

void setCanvases(List<Canvas> canvases)

getDescription

PropertyValue getDescription()

setDescription

void setDescription(PropertyValue description)

Parameters:

description - A sequence may have a description to further explain how it differs from other sequences.

setId

void setId(URI id)

Specified by:

setId in interface IiifResource

Parameters:

id - A sequence may have an id.

getLabel

PropertyValue getLabel()

setLabel

void setLabel(PropertyValue label)

getMetadata

List<Metadata> getMetadata()

setMetadata

void setMetadata(List<Metadata> metadata)

Parameters:

metadata - A sequence may have metadata pairs associated with it to describe the difference between it and other sequences.

getStartCanvas

String getStartCanvas()

setStartCanvas

void setStartCanvas(String startCanvas)

Parameters:

startCanvas - A link from a sequence or range to a canvas that is contained within the sequence. On seeing this relationship, a client should advance to the specified canvas when beginning navigation through the sequence/range. This allows the client to begin with the first canvas that contains interesting content rather than requiring the user to skip past blank or empty canvases manually. A sequence or a range may have this relationship, and the target must be a canvas.

getThumbnail

Thumbnail getThumbnail()

setThumbnail

void setThumbnail(Thumbnail thumbnail)

Parameters:

thumbnail - A sequence may have a thumbnail and should have a thumbnail if there are multiple sequences in a single manifest. Each of the thumbnails should be different.

getViewingDirection

String getViewingDirection()

setViewingDirection

void setViewingDirection(String viewingDirection)

Parameters:

viewingDirection - The direction that canvases of the resource should be presented when rendered for the user to navigate and/or read. A sequence may have a viewing direction, and it MAY be different to that of the manifest.

See Also:

ViewingDirection

getViewingHint

String getViewingHint()

setViewingHint

void setViewingHint(String viewingHint)

Parameters:

viewingHint - A manifest, sequence or range may have a viewing hint, with scope as per viewingDirection.

See Also:

ViewingHint