Package io.goobi.viewer.model.iiif.presentation.v2.builder

Class ManifestBuilder

java.lang.Object

io.goobi.viewer.model.iiif.presentation.v2.builder.AbstractBuilder

io.goobi.viewer.model.iiif.presentation.v2.builder.ManifestBuilder

public class ManifestBuilder
extends AbstractBuilder

Builds IIIF Presentation API v2 Manifest resources from Solr index data and content files.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
protected ImageDeliveryBean	imageDelivery

Fields inherited from class io.goobi.viewer.model.iiif.presentation.v2.builder.AbstractBuilder

config, REQUIRED_SOLR_FIELDS, urls

Constructor Summary

Constructors

Constructor	Description
ManifestBuilder(AbstractApiUrlManager apiUrlManager)	Creates a new ManifestBuilder instance.

Method Summary

Modifier and Type	Method	Description
void	addAnchor(de.intranda.api.iiif.presentation.v2.Manifest2 manifest, String anchorPI)	addAnchor.
void	addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, StructElement ele, Optional<PhysicalElement> page)
void	addSeeAlsos(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, StructElement ele)
void	addVolumes(de.intranda.api.iiif.presentation.v2.Collection2 anchor, List<StructElement> volumes)	addVolumes.
de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2	generateManifest(StructElement ele, List<Integer> pagesToInclude)	generateManifest.
BuildMode	getBuildMode()	Getter for the field buildMode.
protected boolean	isAltoAvailable(StructElement ele, Optional<PhysicalElement> page)
protected boolean	isHasPages(StructElement ele, Optional<PhysicalElement> page)
protected boolean	isPlaintextAvailable(StructElement ele, Optional<PhysicalElement> page)
void	populate(StructElement ele, de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, List<PhysicalElement> pages)	populate.
ManifestBuilder	setBuildMode(BuildMode buildMode)	Setter for the field buildMode.

Methods inherited from class io.goobi.viewer.model.iiif.presentation.v2.builder.AbstractBuilder

absolutize, absolutize, addCrowdourcingAnnotations, addEventMetadataToWorkElement, addLanguageFields, addMetadata, addRendering, addSeeAlso, contained, getAnnotationListURI, getAnnotationListURI, getAnnotationURI, getAnnotationURI, getAttributions, getAutoCompleteServiceURI, getAutoSuggestURI, getCanvasURI, getCollectionURI, getCommentAnnotationURI, getDescription, getDocument, getDocumentWithChildren, getEventFields, getExternalManifestURI, getImageAnnotationURI, getLabel, getLabel, getLabelIfExists, getLayerURI, getLidoResolverUrl, getLocale, getManifestURI, getManifestURI, getMetsResolverUrl, getPageManifestURI, getPageOrderFromCanvasURI, getPIFromCanvasURI, getRangeURI, getRenderings, getSearchServiceURI, getSearchURI, getSeeAlsos, getSequenceURI, getSolrFieldList, getViewUrl

Methods inherited from class java.lang.Object

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

Field Details

imageDelivery

protected ImageDeliveryBean imageDelivery

Constructor Details

ManifestBuilder

public ManifestBuilder(AbstractApiUrlManager apiUrlManager)

Creates a new ManifestBuilder instance.

Parameters:

apiUrlManager - API URL manager for building IIIF resource URIs

Method Details

generateManifest

public de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 generateManifest(StructElement ele,
 List<Integer> pagesToInclude)
                                                                                        throws URISyntaxException,
PresentationException,
IndexUnreachableException,
ViewerConfigurationException,
DAOException

generateManifest.

Parameters:

ele - top-level structure element of the record

pagesToInclude - list of physical page orders to include; empty means all pages

Returns:

the generated IIIF Manifest or Collection for the given structure element

Throws:

URISyntaxException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

ViewerConfigurationException - if any.

DAOException - if any.

populate

public void populate(StructElement ele,
 de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest,
 List<PhysicalElement> pages)
              throws ViewerConfigurationException,
IndexUnreachableException,
DAOException,
PresentationException

populate.

Parameters:

ele - structure element providing metadata and hierarchy

manifest - IIIF presentation element to populate with data

pages - resolved physical pages used for thumbnail and rendering links

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

addSeeAlsos

public void addSeeAlsos(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest,
 StructElement ele)

addRenderings

public void addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest,
 StructElement ele,
 Optional<PhysicalElement> page)

Parameters:

manifest - the manifest to add rendering links to

ele - the top-level structure element of the record

page - optional single page; if present, page-level rendering URLs are used

Throws:

URISyntaxException

isPlaintextAvailable

protected boolean isPlaintextAvailable(StructElement ele,
 Optional<PhysicalElement> page)

isAltoAvailable

protected boolean isAltoAvailable(StructElement ele,
 Optional<PhysicalElement> page)

isHasPages

protected boolean isHasPages(StructElement ele,
 Optional<PhysicalElement> page)

addVolumes

public void addVolumes(de.intranda.api.iiif.presentation.v2.Collection2 anchor,
 List<StructElement> volumes)

addVolumes.

Parameters:

anchor - IIIF collection representing the anchor record

volumes - list of volume structure elements to add as manifests

addAnchor

public void addAnchor(de.intranda.api.iiif.presentation.v2.Manifest2 manifest,
 String anchorPI)
               throws PresentationException,
IndexUnreachableException,
URISyntaxException,
DAOException

addAnchor.

Parameters:

manifest - volume manifest to add the anchor reference to

anchorPI - persistent identifier of the anchor record

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

URISyntaxException - if any.

DAOException - if any.

getBuildMode

public BuildMode getBuildMode()

Getter for the field buildMode.

Returns:

the build mode controlling which parts of the manifest are generated

setBuildMode

public ManifestBuilder setBuildMode(BuildMode buildMode)

Setter for the field buildMode.

Parameters:

buildMode - the build mode controlling which parts of the manifest are generated

Returns:

this ManifestBuilder instance for method chaining