de.digitalcollections.iiif.model.image

Class ImageApiSelector

java.lang.Object

de.digitalcollections.iiif.model.image.ImageApiSelector

All Implemented Interfaces:

Selector

public class ImageApiSelector
extends Object
implements Selector

A selector that describes a region on an IIIF Image API resource.

See http://iiif.io/api/annex/openannotation/#iiif-image-api-selector

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
ImageApiSelector()

Method Summary

Modifier and Type	Method and Description
URI	asImageApiUri(URI baseUri)
static ImageApiSelector	fromImageApiUri(URI imageApiUri)
static ImageApiSelector	fromString(String str)
String	getCanonicalForm(Dimension nativeSize, ImageApiProfile profile, ImageApiProfile.Quality defaultQuality) Create the canonical of the Image API request.
String	getContext()
ImageApiProfile.Format	getFormat()
String	getIdentifier()
ImageApiProfile.Quality	getQuality()
RegionRequest	getRegion()
RotationRequest	getRotation()
SizeRequest	getSize()
String	getType()
void	setFormat(ImageApiProfile.Format format)
void	setIdentifier(String identifier)
void	setQuality(ImageApiProfile.Quality quality)
void	setRegion(RegionRequest region)
void	setRegion(String region)
void	setRotation(RotationRequest rotation)
void	setRotation(String rotation)
void	setSize(SizeRequest size)
void	setSize(String size)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static String CONTEXT

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

ImageApiSelector

public ImageApiSelector()

Method Detail

getContext

public String getContext()

getType

public String getType()

fromImageApiUri

public static ImageApiSelector fromImageApiUri(URI imageApiUri)
                                        throws ResolvingException

Throws:

ResolvingException

fromString

public static ImageApiSelector fromString(String str)
                                   throws ResolvingException

Throws:

ResolvingException

asImageApiUri

public URI asImageApiUri(URI baseUri)

toString

public String toString()

Overrides:

toString in class Object

getCanonicalForm

public String getCanonicalForm(Dimension nativeSize,
                               ImageApiProfile profile,
                               ImageApiProfile.Quality defaultQuality)
                        throws ResolvingException

Create the canonical of the Image API request.

See http://iiif.io/api/image/2.1/#canonical-uri-syntax

Parameters:

nativeSize - Native size of the image the selector is applied to

profile - Image API profile used

defaultQuality - The native/default quality of the image the selector is applied to

Returns:

The canonical form of the Image API request

Throws:

ResolvingException

getIdentifier

public String getIdentifier()

setIdentifier

public void setIdentifier(String identifier)

getRegion

public RegionRequest getRegion()

setRegion

public void setRegion(RegionRequest region)

setRegion

public void setRegion(String region)
               throws ResolvingException

Throws:

ResolvingException

getSize

public SizeRequest getSize()

setSize

public void setSize(SizeRequest size)

setSize

public void setSize(String size)
             throws ResolvingException

Throws:

ResolvingException

getRotation

public RotationRequest getRotation()

setRotation

public void setRotation(RotationRequest rotation)

setRotation

public void setRotation(String rotation)
                 throws ResolvingException

Throws:

ResolvingException

getQuality

public ImageApiProfile.Quality getQuality()

setQuality

public void setQuality(ImageApiProfile.Quality quality)

getFormat

public ImageApiProfile.Format getFormat()

setFormat

public void setFormat(ImageApiProfile.Format format)