de.digitalcollections.iiif.model.sharedcanvas

Class Resource

java.lang.Object

de.digitalcollections.iiif.model.sharedcanvas.Resource

Direct Known Subclasses:

Annotation, AnnotationList, Canvas, Choice, Collection, ContentAsText, ImageContent, Layer, Manifest, OtherContent, Range, Sequence, SpecificResource

public abstract class Resource
extends Object

Abstract IIIF resource, most other resources are based on this.

Field Summary

Fields

Modifier and Type	Field and Description
String	_context Only used during serialization,
static String	CONTEXT

Constructor Summary

Constructors

Constructor and Description
Resource()
Resource(String identifier)

Method Summary

Modifier and Type	Method and Description
Resource	addAttribution(String first, String... rest)
Resource	addDescription(String first, String... rest)
Resource	addLabel(String first, String... rest)
Resource	addLicense(String first, String... rest)
Resource	addLogo(ImageContent first, ImageContent... rest)
Resource	addLogo(String first, String... rest)
Resource	addMetadata(MetadataEntry... meta)
Resource	addMetadata(String label, String value)
Resource	addRelated(OtherContent first, OtherContent... rest)
Resource	addRendering(OtherContent first, OtherContent... rest) Add one or more renderings.
Resource	addSeeAlso(OtherContent first, OtherContent... rest)
Resource	addService(Service first, Service... rest)
Resource	addThumbnail(ImageContent... thumbnails)
Resource	addViewingHint(ViewingHint first, ViewingHint... rest) Add one or more viewing hints for this resource.
Resource	addWithin(Resource first, Resource... rest)
PropertyValue	getAttribution()
String	getAttributionString()
PropertyValue	getDescription()
String	getDescriptionString()
URI	getFirstLicense()
URI	getIdentifier()
PropertyValue	getLabel()
String	getLabelString()
List<URI>	getLicenses()
List<ImageContent>	getLogos()
URI	getLogoUri()
List<MetadataEntry>	getMetadata()
List<OtherContent>	getRelated()
List<OtherContent>	getRenderings()
List<OtherContent>	getSeeAlso()
List<Service>	getServices()
Set<ViewingHint.Type>	getSupportedViewingHintTypes()
ImageContent	getThumbnail()
List<ImageContent>	getThumbnails()
String	getType()
List<ViewingHint>	getViewingHints()
List<Resource>	getWithin()
void	setAttribution(PropertyValue attribution)
void	setDescription(PropertyValue description)
protected void	setIdentifier(URI identifier)
void	setLabel(PropertyValue label)
void	setLicenses(List<URI> licenses)
void	setLogos(List<ImageContent> logos)
void	setRelated(List<OtherContent> related)
void	setRenderings(List<OtherContent> renderings) Sets the renderings.
void	setSeeAlso(List<OtherContent> seeAlso)
void	setServices(List<Service> services)
void	setThumbnails(List<ImageContent> thumbnails)
void	setViewingHints(List<ViewingHint> viewingHints) Set the viewing hints for this resource.
void	setWithin(List<Resource> within)
String	toString()
void	verifyRendering(OtherContent content)

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

_context

public String _context

Only used during serialization,

See Also:

SerializerModifier

Constructor Detail

Resource

public Resource()

Resource

public Resource(String identifier)

Method Detail

getType

public String getType()

getIdentifier

public URI getIdentifier()

setIdentifier

protected void setIdentifier(URI identifier)

getServices

public List<Service> getServices()

setServices

public void setServices(List<Service> services)

addService

public Resource addService(Service first,
                           Service... rest)

getThumbnails

public List<ImageContent> getThumbnails()

getThumbnail

public ImageContent getThumbnail()

setThumbnails

public void setThumbnails(List<ImageContent> thumbnails)

addThumbnail

public Resource addThumbnail(ImageContent... thumbnails)

getMetadata

public List<MetadataEntry> getMetadata()

addMetadata

public Resource addMetadata(MetadataEntry... meta)

addMetadata

public Resource addMetadata(String label,
                            String value)

getLabel

public PropertyValue getLabel()

getLabelString

public String getLabelString()

setLabel

public void setLabel(PropertyValue label)

addLabel

public Resource addLabel(String first,
                         String... rest)

getDescription

public PropertyValue getDescription()

getDescriptionString

public String getDescriptionString()

setDescription

public void setDescription(PropertyValue description)

addDescription

public Resource addDescription(String first,
                               String... rest)

getAttribution

public PropertyValue getAttribution()

getAttributionString

public String getAttributionString()

setAttribution

public void setAttribution(PropertyValue attribution)

addAttribution

public Resource addAttribution(String first,
                               String... rest)

getLicenses

public List<URI> getLicenses()

getFirstLicense

public URI getFirstLicense()

setLicenses

public void setLicenses(List<URI> licenses)

addLicense

public Resource addLicense(String first,
                           String... rest)

getLogos

public List<ImageContent> getLogos()

getLogoUri

public URI getLogoUri()

setLogos

public void setLogos(List<ImageContent> logos)

addLogo

public Resource addLogo(String first,
                        String... rest)

addLogo

public Resource addLogo(ImageContent first,
                        ImageContent... rest)

getSupportedViewingHintTypes

public Set<ViewingHint.Type> getSupportedViewingHintTypes()

getViewingHints

public List<ViewingHint> getViewingHints()

setViewingHints

public void setViewingHints(List<ViewingHint> viewingHints)
                     throws IllegalArgumentException

Set the viewing hints for this resource.

Parameters:

viewingHints - list of viewing hints

Throws:

IllegalArgumentException - if the resources not not support one of the viewing hints.

addViewingHint

public Resource addViewingHint(ViewingHint first,
                               ViewingHint... rest)
                        throws IllegalArgumentException

Add one or more viewing hints for this resource.

Parameters:

first - first viewing hint to add

rest - list of second and more viewing hints

Returns:

this resource with added viewing hints

Throws:

IllegalArgumentException - if the resources not not support one of the viewing hints.

getRelated

public List<OtherContent> getRelated()

setRelated

public void setRelated(List<OtherContent> related)

addRelated

public Resource addRelated(OtherContent first,
                           OtherContent... rest)

getRenderings

public List<OtherContent> getRenderings()

setRenderings

public void setRenderings(List<OtherContent> renderings)
                   throws IllegalArgumentException

Sets the renderings. All renderings must have both a profile and a format.

Throws:

IllegalArgumentException - if at least one rendering does not have both a profile and a format.

addRendering

public Resource addRendering(OtherContent first,
                             OtherContent... rest)

Add one or more renderings. All renderings must have both a profile and a format.

Throws:

IllegalArgumentException - if at least one rendering does not have both a profile and a format.

verifyRendering

public void verifyRendering(OtherContent content)

getSeeAlso

public List<OtherContent> getSeeAlso()

setSeeAlso

public void setSeeAlso(List<OtherContent> seeAlso)

addSeeAlso

public Resource addSeeAlso(OtherContent first,
                           OtherContent... rest)

getWithin

public List<Resource> getWithin()

setWithin

public void setWithin(List<Resource> within)

addWithin

public Resource addWithin(Resource first,
                          Resource... rest)

toString

public String toString()

Overrides:

toString in class Object