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

Class SequenceBuilder

java.lang.Object

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

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

public class SequenceBuilder
extends AbstractBuilder

SequenceBuilder class.

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
SequenceBuilder(AbstractApiUrlManager apiUrlManager)	Constructor for SequenceBuilder.

Method Summary

Modifier and Type	Method	Description
Map<de.intranda.api.iiif.presentation.enums.AnnotationType,List<de.intranda.api.iiif.presentation.v2.AnnotationList>>	addBaseSequence(de.intranda.api.iiif.presentation.v2.Manifest2 manifest, StructElement doc, String manifestId, List<Integer> pagesToInclude, jakarta.servlet.http.HttpServletRequest request)	Creates a sequence from all pages within the given doc and appends it to manifest.
List<de.intranda.api.iiif.presentation.v2.AnnotationList>	addComments(Map<Integer,de.intranda.api.iiif.presentation.v2.Canvas2> canvases, String pi, boolean populate)	Adds a comment annotation to all cavases which contain comments.
Map<de.intranda.api.iiif.presentation.enums.AnnotationType,de.intranda.api.iiif.presentation.v2.AnnotationList>	addOtherContent(StructElement doc, PhysicalElement page, de.intranda.api.iiif.presentation.v2.Canvas2 canvas, boolean populate)	addOtherContent.
void	addRenderings(PhysicalElement page, de.intranda.api.iiif.presentation.v2.Canvas2 canvas)
void	addSeeAlsos(de.intranda.api.iiif.presentation.v2.Canvas2 canvas, PhysicalElement page)	addSeeAlsos.
de.intranda.api.iiif.presentation.v2.Canvas2	generateCanvas(String pi, PhysicalElement page)	generateCanvas.
BuildMode	getBuildMode()	Getter for the field buildMode.
PhysicalElement	getPage(StructElement doc, int order)	getPage.
PageType	getPreferedView()	Getter for the field preferredView.
void	merge(Map<de.intranda.api.iiif.presentation.enums.AnnotationType,List<de.intranda.api.iiif.presentation.v2.AnnotationList>> annotationMap, Map<de.intranda.api.iiif.presentation.enums.AnnotationType,de.intranda.api.iiif.presentation.v2.AnnotationList> content)	merge.
SequenceBuilder	setBuildMode(BuildMode buildMode)	Setter for the field buildMode.
SequenceBuilder	setPreferedView(PageType preferredView)	Setter for the field preferredView.

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

SequenceBuilder

public SequenceBuilder(AbstractApiUrlManager apiUrlManager)

Constructor for SequenceBuilder.

Parameters:

apiUrlManager -

Method Details

addBaseSequence

public Map<de.intranda.api.iiif.presentation.enums.AnnotationType,List<de.intranda.api.iiif.presentation.v2.AnnotationList>> addBaseSequence(de.intranda.api.iiif.presentation.v2.Manifest2 manifest,
 StructElement doc,
 String manifestId,
 List<Integer> pagesToInclude,
 jakarta.servlet.http.HttpServletRequest request)
                                                                                                                                      throws URISyntaxException,
PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Creates a sequence from all pages within the given doc and appends it to manifest.

Parameters:

manifest - The manifest to include the sequence. May be null

doc - a StructElement object.

manifestId - a String object.

pagesToInclude -

request -

Returns:

a Map object.

Throws:

URISyntaxException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

addSeeAlsos

public void addSeeAlsos(de.intranda.api.iiif.presentation.v2.Canvas2 canvas,
 PhysicalElement page)
                 throws URISyntaxException,
ViewerConfigurationException

addSeeAlsos.

Parameters:

canvas - a Canvas2 object.

page - a PhysicalElement object.

Throws:

URISyntaxException - if any.

ViewerConfigurationException - if any.

addRenderings

public void addRenderings(PhysicalElement page,
 de.intranda.api.iiif.presentation.v2.Canvas2 canvas)

Parameters:

page -

canvas -

addComments

public List<de.intranda.api.iiif.presentation.v2.AnnotationList> addComments(Map<Integer,de.intranda.api.iiif.presentation.v2.Canvas2> canvases,
 String pi,
 boolean populate)
                                                                      throws DAOException,
URISyntaxException,
ViewerConfigurationException

Adds a comment annotation to all cavases which contain comments.

Parameters:

canvases - All canvases which may get comments, mapped by their page order

pi - The pi of the work containing the pages

populate - if true, the actual annotations will be included in the resources property

Returns:

a map with the list of all annotationlists (one list per page)

Throws:

DAOException - if any.

URISyntaxException - if any.

ViewerConfigurationException - if any.

merge

public void merge(Map<de.intranda.api.iiif.presentation.enums.AnnotationType,List<de.intranda.api.iiif.presentation.v2.AnnotationList>> annotationMap,
 Map<de.intranda.api.iiif.presentation.enums.AnnotationType,de.intranda.api.iiif.presentation.v2.AnnotationList> content)

merge.

Parameters:

annotationMap - a Map object.

content - a Map object.

getPage

public PhysicalElement getPage(StructElement doc,
 int order)
                        throws IndexUnreachableException,
DAOException,
PresentationException

getPage.

Parameters:

doc - a StructElement object.

order - a int.

Returns:

a PhysicalElement object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException

generateCanvas

public de.intranda.api.iiif.presentation.v2.Canvas2 generateCanvas(String pi,
 PhysicalElement page)
                                                            throws URISyntaxException,
ViewerConfigurationException,
IndexUnreachableException,
PresentationException,
DAOException

generateCanvas.

Parameters:

pi - Record identifier

page - a PhysicalElement object.

Returns:

a Canvas2 object.

Throws:

URISyntaxException - if any.

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

PresentationException - if any.

DAOException

addOtherContent

public Map<de.intranda.api.iiif.presentation.enums.AnnotationType,de.intranda.api.iiif.presentation.v2.AnnotationList> addOtherContent(StructElement doc,
 PhysicalElement page,
 de.intranda.api.iiif.presentation.v2.Canvas2 canvas,
 boolean populate)
                                                                                                                                throws URISyntaxException,
IndexUnreachableException,
ViewerConfigurationException

addOtherContent.

Parameters:

doc - a StructElement object.

page - a PhysicalElement object.

canvas - a Canvas2 object.

populate - a boolean.

Returns:

a Map object.

Throws:

URISyntaxException - if any.

IndexUnreachableException - if any.

ViewerConfigurationException - if any.

getBuildMode

public BuildMode getBuildMode()

Getter for the field buildMode.

Returns:

the buildMode

setBuildMode

public SequenceBuilder setBuildMode(BuildMode buildMode)

Setter for the field buildMode.

Parameters:

buildMode - the buildMode to set

Returns:

a SequenceBuilder object.

getPreferedView

public PageType getPreferedView()

Getter for the field preferredView.

Returns:

the preferredView

setPreferedView

public SequenceBuilder setPreferedView(PageType preferredView)

Setter for the field preferredView.

Parameters:

preferredView - the preferredView to set

Returns:

a SequenceBuilder object.