This module contains model classes for all currently available IIIF API entities, namely for the Presentation, Image, Content Search and Authentication APIs, as well as the additional services defined in the Service Annex. It also includes all the necessary components to parse and create valid JSON-LD representations of these entities, using Jackson.
The library contains a comprehensive test suite for all entities, based on all of the examples provided in the IIIF specifications. Therefore, it should be able to parse and create any IIIF documents that are compliant with the official specifications. If you find that you cannot parse a IIIF entity that you believe to be correct, please submit an issue including a link to the JSON-LD representation of the entity. Likewise, if you find that you cannot express a certain IIIF construct with the Java API, let us know.
It is intended to replace both iiif-presentation-api and iiif-image-api once it is stable enough, with the non-model parts of these libraries being moved into hymir.
To use the module, first add it to your project's Maven or Gradle configuration:
<dependency>
<groupId>de.digitalcollections.iiif</groupId>
<artifactId>iiif-apis</artifactId>
<version>0.3.10</version>
</dependency>dependencies {
compile 'de.digitalcollections.iiif.iiif-apis:0.3.10'
}For both reading and writing IIIF JSON-LD documents, it is neccessary to instantiate the Jackson object mapper:
import de.digitalcollections.iiif.model.jackson.IiifObjectMapper;
ObjectMapper iiifMapper = new IiifObjectMapper();The mapper can then be used to read IIIF JSON-LD documents into their corresponding Java object:
import de.digitalcollections.iiif.model.sharedcanvas.Manifest;
// Reading a manifest
Manifest manifest = iiifMapper.readValue(
"https://iiif.biblissima.fr/manifests/ark:/12148/btv1b8304502m/manifest.json",
Manifest.class);
// Reading an annotation list
AnnotationList annoList = iiifMapper.readValue(
"https://dams.llgc.org.uk/iiif/4342443/annotation/list/ART8.json",
AnnotationList.class);To create your own IIIF entities, just model them using the available classes and use the object mapper to obtain their JSON-LD representation:
import de.digitalcollections.iiif.model.sharedcanvas.Canvas;
import de.digitalcollections.iiif.model.ImageContent;
import de.digitalcollections.iiif.model.image.ImageApiProfile;
import de.digitalcollections.iiif.model.image.ImageService;
import de.digitalcollections.iiif.model.OtherContent;
import de.digitalcollections.iiif.model.search.ContentSearchService;
import de.digitalcollections.iiif.model.PropertyValue;
import java.util.Locale;
Canvas canvas = new Canvas("https://some.uri");
canvas.addLabel("A label");
canvas.addDescription("This is a slightly longer text about this canvas.");
canvas.setWidth(800);
canvas.setHeight(600);
// Image
canvas.addIIIFImage("https://some.uri/iiif/foo", ImageApiProfile.LEVEL_ONE);
// Thumbnail
ImageContent thumbnail = new ImageContent("https://some.uri/iiif/foo/full/250,/0/default.jpg");
thumbnail.addService(new ImageService("https://some.uri/iiif/foo", ImageApiProfile.LEVEL_ONE));
canvas.addThumbnail(thumbnail);
// Other Content
canvas.addSeeAlso(new OtherContent("https://some.uri/ocr/foo.hocr", "text/html"));
// Search Service
ContentSearchService searchService = new ContentSearchService("https://some.uri/search/foo");
searchService.addAutocompleteService("https://some.uri/autocomplete/foo");
canvas.addService(searchService);
// Metadata
canvas.addMetadata("Author", "Ignatius Jacques Reilly");
canvas.addMetadata("Location", "New Orleans");
PropertyValue key = new PropertyValue();
key.addValue(Locale.ENGLISH, "Key");
key.addValue(Locale.GERMAN, "Schlüssel");
key.addValue(Locale.CHINESE, "钥");
PropertyValue value = new PropertyValue();
value.addValue(Locale.ENGLISH, "A value", "Another value");
value.addValue(Locale.GERMAN, "Ein Wert", "Noch ein Wert");
value.addValue(Locale.CHINESE, "值", "另值");
canvas.addMetadata(new MetadataEntry(key, value));
// Other stuff
canvas.addViewingHint(ViewingHint.NON_PAGED);
// Licensing/Attribution
canvas.addLicense("https://rightsstatements.org/vocab/NoC-NC/1.0/");
canvas.addAttribution("Some fictional institution");
canvas.addLogo("https://some.uri/logo.jpg");
canvas.addLogo(new ImageContent(new ImageService(
"https://some.uri/iiif/logo", ImageApiProfile.LEVEL_ONE)));
String json = iiifMapper.writerWithDefaultPrettyPrinter().writeValueAsString(canvas);For more information on how to use the API, consult the API documentation and the comprehensive test suite. Since the large majority of the tests are based on the examples from the specifications, they should be very easy to follow along.