Package de.digitalcollections.iiif.model.image

Class ImageApiProfile

java.lang.Object

de.digitalcollections.iiif.model.Profile

de.digitalcollections.iiif.model.image.ImageApiProfile

public class ImageApiProfile
extends Profile

An Image API profile.

Can be either a simple pre-defined profile (e.g. LEVEL_ZERO) or a complex profile describing the available features of a given IIIF image.

See http://iiif.io/api/image/2.1/#profile-description for an overview of all available properties and features and http://iiif.io/api/image/2.1/compliance/ for an overview of the available compliance levels.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageApiProfile.Feature
static class	ImageApiProfile.Format
static class	ImageApiProfile.Quality

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTEXT
static ImageApiProfile	LEVEL_ONE
static ImageApiProfile	LEVEL_TWO
static ImageApiProfile	LEVEL_ZERO
static String	TYPE
static Set<String>	V1_PROFILES

Constructor Summary

Constructors

Constructor	Description
ImageApiProfile()

Method Summary

Modifier and Type	Method	Description
ImageApiProfile	addFeature(ImageApiProfile.Feature first, ImageApiProfile.Feature... rest)
ImageApiProfile	addFormat(ImageApiProfile.Format first, ImageApiProfile.Format... rest)
ImageApiProfile	addQuality(ImageApiProfile.Quality first, ImageApiProfile.Quality... rest)
boolean	equals(Object o)
static ImageApiProfile	fromUrl(String url)
Set<ImageApiProfile.Feature>	getFeatures()
Set<ImageApiProfile.Format>	getFormats()
Long	getMaxArea()
Integer	getMaxHeight()
Integer	getMaxWidth()
Set<ImageApiProfile.Quality>	getQualities()
int	hashCode()
ImageApiProfile	merge(ImageApiProfile other)	Merge two profiles.
static ImageApiProfile	merge(List<Profile> profiles)	Merge multiple profiles into one.
void	setFeatures(Set<ImageApiProfile.Feature> features)
void	setFormats(Set<ImageApiProfile.Format> formats)
void	setMaxArea(Long maxArea)
void	setMaxHeight(Integer maxHeight)
void	setMaxWidth(Integer maxWidth)
void	setQualities(Set<ImageApiProfile.Quality> qualities)
String	toString()

Methods inherited from class de.digitalcollections.iiif.model.Profile

getIdentifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LEVEL_ZERO

public static final ImageApiProfile LEVEL_ZERO

LEVEL_ONE

public static final ImageApiProfile LEVEL_ONE

LEVEL_TWO

public static final ImageApiProfile LEVEL_TWO

V1_PROFILES

public static final Set<String> V1_PROFILES

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

ImageApiProfile

public ImageApiProfile()

Method Detail

fromUrl

public static ImageApiProfile fromUrl(String url)

getFormats

public Set<ImageApiProfile.Format> getFormats()

setFormats

public void setFormats(Set<ImageApiProfile.Format> formats)

addFormat

public ImageApiProfile addFormat(ImageApiProfile.Format first,
                                 ImageApiProfile.Format... rest)

getQualities

public Set<ImageApiProfile.Quality> getQualities()

setQualities

public void setQualities(Set<ImageApiProfile.Quality> qualities)

addQuality

public ImageApiProfile addQuality(ImageApiProfile.Quality first,
                                  ImageApiProfile.Quality... rest)

getFeatures

public Set<ImageApiProfile.Feature> getFeatures()

setFeatures

public void setFeatures(Set<ImageApiProfile.Feature> features)

addFeature

public ImageApiProfile addFeature(ImageApiProfile.Feature first,
                                  ImageApiProfile.Feature... rest)

getMaxArea

public Long getMaxArea()

setMaxArea

public void setMaxArea(Long maxArea)

getMaxHeight

public Integer getMaxHeight()

setMaxHeight

public void setMaxHeight(Integer maxHeight)

getMaxWidth

public Integer getMaxWidth()

setMaxWidth

public void setMaxWidth(Integer maxWidth)

merge

public static ImageApiProfile merge(List<Profile> profiles)

Merge multiple profiles into one. Useful for image servers that want to consolidate the limits given in a info.json.

Parameters:

profiles - profiles to be merged

Returns:

merged profile

merge

public ImageApiProfile merge(ImageApiProfile other)

Merge two profiles.

Parameters:

other - profile to be merged

Returns:

merged profile

equals

public boolean equals(Object o)

Overrides:

equals in class Profile

hashCode

public int hashCode()

Overrides:

hashCode in class Profile

toString

public String toString()

Overrides:

toString in class Object