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

Class StructureBuilder

java.lang.Object

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

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

public class StructureBuilder
extends AbstractBuilder

StructureBuilder class.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_RANGE_LABEL	Constant BASE_RANGE_LABEL="CONTENT".
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
StructureBuilder(AbstractApiUrlManager apiUrlManager)	Constructor for StructureBuilder.

Method Summary

Modifier and Type	Method	Description
void	addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 range, StructElement ele)
List<de.intranda.api.iiif.presentation.v2.Range2>	generateStructure(List<StructElement> elements, String pi, boolean useMembers)	Generates the topmost range from the given elements.
List<de.intranda.api.iiif.presentation.v2.Range2>	getDescendents(de.intranda.api.iiif.presentation.v2.Range2 range)	getDescendents.
void	populate(StructElement ele, String pi, de.intranda.api.iiif.presentation.v2.Range2 range)	Adds Metadata and links to external services to a range.
void	populatePages(StructElement doc, String pi, de.intranda.api.iiif.presentation.v2.Range2 range)	populatePages.

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

BASE_RANGE_LABEL

public static final String BASE_RANGE_LABEL

Constant BASE_RANGE_LABEL="CONTENT".

See Also:

• Constant Field Values

Constructor Details

StructureBuilder

public StructureBuilder(AbstractApiUrlManager apiUrlManager)

Constructor for StructureBuilder.

Parameters:

apiUrlManager -

Method Details

generateStructure

public List<de.intranda.api.iiif.presentation.v2.Range2> generateStructure(List<StructElement> elements,
 String pi,
 boolean useMembers)
                                                                    throws ViewerConfigurationException,
IndexUnreachableException,
DAOException,
PresentationException,
URISyntaxException

Generates the topmost range from the given elements. This is an abstract "CONTENT" range if baseElement is a work, or the range representing the given baseElement otherwise.

Parameters:

elements - All elements to include in the list

pi - a String object.

useMembers - a boolean.

Returns:

a List object.

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

URISyntaxException - if any.

populate

public void populate(StructElement ele,
 String pi,
 de.intranda.api.iiif.presentation.v2.Range2 range)
              throws ViewerConfigurationException,
IndexUnreachableException,
DAOException,
PresentationException

Adds Metadata and links to external services to a range.

Parameters:

ele - a StructElement object.

pi - a String object.

range - a Range2 object.

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

addRenderings

public void addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 range,
 StructElement ele)

Parameters:

range -

ele -

populatePages

public void populatePages(StructElement doc,
 String pi,
 de.intranda.api.iiif.presentation.v2.Range2 range)
                   throws URISyntaxException,
IndexUnreachableException

populatePages.

Parameters:

doc - a StructElement object.

pi - a String object.

range - a Range2 object.

Throws:

URISyntaxException - if any.

IndexUnreachableException - if any.

getDescendents

public List<de.intranda.api.iiif.presentation.v2.Range2> getDescendents(de.intranda.api.iiif.presentation.v2.Range2 range)

getDescendents.

Parameters:

range - a Range2 object.

Returns:

a List object.