de.digitalcollections.iiif.model.sharedcanvas

Class Range

java.lang.Object

de.digitalcollections.iiif.model.sharedcanvas.Resource

de.digitalcollections.iiif.model.sharedcanvas.Range

public class Range
extends Resource

An ordered list of canvases, and/or further ranges.

Ranges allow canvases, or parts thereof, to be grouped together in some way. This could be for textual reasons, such as to distinguish books, chapters, verses, sections, non-content-bearing pages, the table of contents or similar. Equally, physical features might be important such as quires or gatherings, sections that have been added later and so forth.

See http://iiif.io/api/presentation/2.1/#range

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

_context, CONTEXT

Constructor Summary

Constructors

Constructor and Description
Range(String identifier)
Range(String identifier, String label)

Method Summary

Modifier and Type	Method and Description
Range	addCanvas(Canvas first, Canvas... rest)
Range	addCanvas(String idOfFirst, String... idsOfRest)
Range	addMember(Resource first, Resource... rest) Adds one or more member resources.
Range	addRange(Range first, Range... rest)
Range	addRange(String first, String... rest)
List<Canvas>	getCanvases()
Layer	getContentLayer()
List<Resource>	getMembers()
List<Range>	getRanges()
URI	getStartCanvas()
Set<ViewingHint.Type>	getSupportedViewingHintTypes()
String	getType()
ViewingDirection	getViewingDirection()
void	setCanvases(List<Canvas> canvases)
void	setContentLayer(Layer contentLayer)
void	setContentLayer(String identifier)
void	setMembers(List<Resource> members) Sets the member resources.
void	setRanges(List<Range> ranges)
void	setStartCanvas(URI startCanvas)
void	setViewingDirection(ViewingDirection viewingDirection)

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

addAttribution, addDescription, addLabel, addLicense, addLogo, addLogo, addMetadata, addMetadata, addRelated, addRendering, addSeeAlso, addService, addThumbnail, addViewingHint, addWithin, getAttribution, getAttributionString, getDescription, getDescriptionString, getFirstLicense, getIdentifier, getLabel, getLabelString, getLicenses, getLogos, getLogoUri, getMetadata, getRelated, getRenderings, getSeeAlso, getServices, getThumbnail, getThumbnails, getViewingHints, getWithin, setAttribution, setDescription, setIdentifier, setLabel, setLicenses, setLogos, setRelated, setRenderings, setSeeAlso, setServices, setThumbnails, setViewingHints, setWithin, toString, verifyRendering

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

Range

public Range(String identifier)

Range

public Range(String identifier,
             String label)

Method Detail

getType

public String getType()

Overrides:

getType in class Resource

getViewingDirection

public ViewingDirection getViewingDirection()

setViewingDirection

public void setViewingDirection(ViewingDirection viewingDirection)

getSupportedViewingHintTypes

public Set<ViewingHint.Type> getSupportedViewingHintTypes()

Overrides:

getSupportedViewingHintTypes in class Resource

getStartCanvas

public URI getStartCanvas()

setStartCanvas

public void setStartCanvas(URI startCanvas)

getContentLayer

public Layer getContentLayer()

setContentLayer

public void setContentLayer(Layer contentLayer)

setContentLayer

public void setContentLayer(String identifier)

getCanvases

public List<Canvas> getCanvases()

setCanvases

public void setCanvases(List<Canvas> canvases)

addCanvas

public Range addCanvas(Canvas first,
                       Canvas... rest)

addCanvas

public Range addCanvas(String idOfFirst,
                       String... idsOfRest)

getRanges

public List<Range> getRanges()

setRanges

public void setRanges(List<Range> ranges)

addRange

public Range addRange(Range first,
                      Range... rest)

addRange

public Range addRange(String first,
                      String... rest)

getMembers

public List<Resource> getMembers()

setMembers

public void setMembers(List<Resource> members)

Sets the member resources. Must be either instances of Range or Canvas. All members must have an identifier and a label.

Throws:

IllegalArgumentException - if at least one member is not a Range or Canvas or does not have an identifier and a label;

addMember

public Range addMember(Resource first,
                       Resource... rest)
                throws IllegalArgumentException

Adds one or more member resources. Must be either instances of Range or Canvas. All members must have an identifier and a label.

Throws:

IllegalArgumentException - if at least one member is not a Range or Canvas or does not have an identifier and a label;