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

Interface Content

All Superinterfaces:

IiifResource

All Known Subinterfaces:

ImageContent, OtherContent

public interface Content
extends IiifResource

Content resources such as images or texts that are associated with a canvas.

• A canvas or content resource must not have a viewing direction.

Method Summary

Modifier and Type	Method and Description
PropertyValue	getDescription()
String	getFormat()
int	getHeight()
List<Metadata>	getMetadata()
Thumbnail	getThumbnail()
String	getViewingHint()
int	getWidth()
void	setDescription(PropertyValue description)
void	setFormat(String format)
void	setHeight(int height)
void	setMetadata(List<Metadata> metadata)
void	setThumbnail(Thumbnail thumbnail)
void	setViewingHint(String viewingHint)
void	setWidth(int width)

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

addService, getAttribution, getId, getLicense, getLogo, getRelated, getRendering, getSeeAlso, getServices, getType, getWithin, setAttribution, setId, setId, setLicense, setLogo, setRelated, setRendering, setSeeAlso, setServices, setWithin

Method Detail

getDescription

PropertyValue getDescription()

setDescription

void setDescription(PropertyValue description)

Parameters:

description - A content resource may have a description.

getFormat

String getFormat()

setFormat

void setFormat(String format)

Parameters:

format - The specific media type (often called a MIME type) of a content resource, for example “image/jpeg”. This is important for distinguishing text in XML from plain text, for example. A content resource may have a format, and if so, it must be the value of the Content-Type header returned when the resource is dereferenced. N.B. This is different to the formats property in the Image API, which gives the extension to use within that API. It would be inappropriate to use in this case, as format can be used with any content resource, not just images.

getHeight

int getHeight()

setHeight

void setHeight(int height)

Parameters:

height - The height of a canvas or image resource. For images, this is in pixels. No particular units are required for canvases, as the dimensions provide an aspect ratio for the resources to be located within rather than measuring any physical property of the object. Content resources may have a height, given in pixels, if appropriate.

getMetadata

List<Metadata> getMetadata()

setMetadata

void setMetadata(List<Metadata> metadata)

Parameters:

metadata - A content resource may have metadata pairs associated with it.

getThumbnail

Thumbnail getThumbnail()

setThumbnail

void setThumbnail(Thumbnail thumbnail)

Parameters:

thumbnail - A content resource may have a thumbnail and should have a thumbnail if it is an option in a choice of resources.

getViewingHint

String getViewingHint()

setViewingHint

void setViewingHint(String viewingHint)

Parameters:

viewingHint - A content resource may have a viewing hint but there are no defined values in this specification.

getWidth

int getWidth()

setWidth

void setWidth(int width)

Parameters:

width - The width of a canvas or image resource. For images, this is in pixels. No particular units are required for canvases. Content resources may have a height, given in pixels, if appropriate.