Package io.goobi.viewer.api.rest.resourcebuilders

Class IIIFPresentation2ResourceBuilder

java.lang.Object

io.goobi.viewer.api.rest.resourcebuilders.IIIFPresentation2ResourceBuilder

public class IIIFPresentation2ResourceBuilder
extends Object

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
IIIFPresentation2ResourceBuilder(AbstractApiUrlManager urls, HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
de.intranda.api.iiif.presentation.v2.Sequence	getBaseSequence(String pi, BuildMode buildMode, String preferedViewName)
de.intranda.api.iiif.presentation.IPresentationModelElement	getCanvas(String pi, Integer pageNo)
de.intranda.api.iiif.presentation.v2.Collection2	getCollection(String collectionField, String topElement, List<String> ignore)	Returns a iiif collection of the given topCollection for the give collection field.
CollectionBuilder	getCollectionBuilder()	Getter for the field collectionBuilder.
de.intranda.api.iiif.presentation.v2.Collection2	getCollections(String collectionField, List<String> ignore)	Returns a iiif collection of all collections from the given solr-field.
de.intranda.api.iiif.presentation.v2.Collection2	getCollectionsWithGrouping(String collectionField, List<String> ignore, String groupingField)	Returns a iiif collection of all collections from the given solr-field.
de.intranda.api.iiif.presentation.v2.Collection2	getCollectionWithGrouping(String collectionField, String topElement, String facetField, List<String> ignore)	Returns a iiif collection of the given topCollection for the give collection field The response includes the metadata and subcollections of the direct child collections.
de.intranda.api.iiif.presentation.v2.Layer	getLayer(String pi, String typeName)
LayerBuilder	getLayerBuilder()	Getter for the field layerBuilder.
de.intranda.api.iiif.presentation.IPresentationModelElement	getManifest(String pi, List<Integer> pagesToInclude, BuildMode mode)
ManifestBuilder	getManifestBuilder()	Getter for the field manifestBuilder.
List<de.intranda.api.iiif.presentation.IPresentationModelElement>	getManifestsForQuery(String query, String sortFields, int first, int rows)
PageType	getPreferedPageTypeForCanvas(String preferredViewName)
de.intranda.api.iiif.presentation.v2.Range2	getRange(String pi, String logId)
SequenceBuilder	getSequenceBuilder()	Getter for the field sequenceBuilder.

Methods inherited from class java.lang.Object

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

Constructor Details

IIIFPresentation2ResourceBuilder

public IIIFPresentation2ResourceBuilder(AbstractApiUrlManager urls,
 HttpServletRequest request)

Method Details

getManifest

public de.intranda.api.iiif.presentation.IPresentationModelElement getManifest(String pi,
 List<Integer> pagesToInclude,
 BuildMode mode)
                                                                        throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
URISyntaxException,
ViewerConfigurationException,
DAOException

Parameters:

pi - persistent identifier of the record to build

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

mode - build mode controlling which resources are included

Returns:

IPresentationModelElement

Throws:

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

URISyntaxException

ViewerConfigurationException

DAOException

getRange

public de.intranda.api.iiif.presentation.v2.Range2 getRange(String pi,
 String logId)
                                                     throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
URISyntaxException,
ViewerConfigurationException,
DAOException

Parameters:

pi - persistent identifier of the record to search

logId - logical struct ID identifying the target range

Returns:

Range2

Throws:

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

URISyntaxException

ViewerConfigurationException

DAOException

getBaseSequence

public de.intranda.api.iiif.presentation.v2.Sequence getBaseSequence(String pi,
 BuildMode buildMode,
 String preferedViewName)
                                                              throws PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Parameters:

pi - persistent identifier of the record to build

buildMode - build mode controlling which resources are included

preferedViewName - name of the preferred page type for canvas links

Returns:

Sequence

Throws:

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getPreferedPageTypeForCanvas

public PageType getPreferedPageTypeForCanvas(String preferredViewName)

Parameters:

preferredViewName - view name string to resolve to a page type

Returns:

Preferred PageType for given preferredViewName

getLayer

public de.intranda.api.iiif.presentation.v2.Layer getLayer(String pi,
 String typeName)
                                                    throws PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
IOException

Parameters:

pi - persistent identifier of the record

typeName - annotation type name used to select the layer content

Returns:

Layer

Throws:

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

IOException

getCanvas

public de.intranda.api.iiif.presentation.IPresentationModelElement getCanvas(String pi,
 Integer pageNo)
                                                                      throws URISyntaxException,
ViewerConfigurationException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
PresentationException,
IndexUnreachableException,
DAOException

Parameters:

pi - persistent identifier of the record

pageNo - physical page number of the canvas to retrieve

Returns:

IPresentationModelElement

Throws:

ViewerConfigurationException

URISyntaxException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

IndexUnreachableException

PresentationException

DAOException

getManifestBuilder

public ManifestBuilder getManifestBuilder()

Getter for the field manifestBuilder.

Returns:

the ManifestBuilder used to construct IIIF manifests

getSequenceBuilder

public SequenceBuilder getSequenceBuilder()

Getter for the field sequenceBuilder.

Returns:

the SequenceBuilder used to construct IIIF sequences of canvases

getLayerBuilder

public LayerBuilder getLayerBuilder()

Getter for the field layerBuilder.

Returns:

the LayerBuilder used to construct IIIF annotation layers

getCollections

public de.intranda.api.iiif.presentation.v2.Collection2 getCollections(String collectionField,
 List<String> ignore)
                                                                throws PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Returns a iiif collection of all collections from the given solr-field. The response includes the metadata and subcollections of the topmost collections. Child collections may be accessed following the links in the @id properties in the member-collections Requires passing a language to set the language for all metadata values

Parameters:

collectionField - Solr field name that holds the collection values

ignore - list of collection names to exclude from the result

Returns:

the IIIF Presentation v2 Collection containing all top-level collections for the given Solr field

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

URISyntaxException - if any.

ViewerConfigurationException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollectionsWithGrouping

public de.intranda.api.iiif.presentation.v2.Collection2 getCollectionsWithGrouping(String collectionField,
 List<String> ignore,
 String groupingField)
                                                                            throws PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Returns a iiif collection of all collections from the given solr-field. The response includes the metadata and subcollections of the topmost collections. Child collections may be accessed following the links in the @id properties in the member-collections Requires passing a language to set the language for all metadata values

Parameters:

collectionField - Solr field name that holds the collection values

ignore - list of collection names to exclude from the result

groupingField - Solr field used to group collections within the response

Returns:

the IIIF Presentation v2 Collection containing all top-level collections grouped by the given Solr field

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

URISyntaxException - if any.

ViewerConfigurationException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollection

public de.intranda.api.iiif.presentation.v2.Collection2 getCollection(String collectionField,
 String topElement,
 List<String> ignore)
                                                               throws IndexUnreachableException,
URISyntaxException,
PresentationException,
ViewerConfigurationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Returns a iiif collection of the given topCollection for the give collection field. The response includes the metadata and subcollections of the direct child collections. Collections further down the hierarchy may be accessed following the links in the @id properties in the member-collections Requires passing a language to set the language for all metadata values

Parameters:

collectionField - Solr field name that holds the collection values

topElement - name of the root collection to use as the response root

ignore - list of collection names to exclude from the result

Returns:

the IIIF Presentation v2 Collection rooted at the given top-level collection element

Throws:

IndexUnreachableException - if any.

URISyntaxException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException - If the topElement is not a collection

getManifestsForQuery

public List<de.intranda.api.iiif.presentation.IPresentationModelElement> getManifestsForQuery(String query,
 String sortFields,
 int first,
 int rows)
                                                                                       throws DAOException,
PresentationException,
IndexUnreachableException,
URISyntaxException,
ViewerConfigurationException

Parameters:

query - Solr query string to select matching records

sortFields - comma-separated Solr sort field expressions

first - zero-based offset of the first result to return

rows - maximum number of results to return

Returns:

List

Throws:

DAOException

PresentationException

IndexUnreachableException

URISyntaxException

ViewerConfigurationException

getCollectionWithGrouping

public de.intranda.api.iiif.presentation.v2.Collection2 getCollectionWithGrouping(String collectionField,
 String topElement,
 String facetField,
 List<String> ignore)
                                                                           throws IndexUnreachableException,
URISyntaxException,
PresentationException,
ViewerConfigurationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Returns a iiif collection of the given topCollection for the give collection field The response includes the metadata and subcollections of the direct child collections. Collections further down the hierarchy may be accessed following the links in the @id properties in the member-collections Requires passing a language to set the language for all metadata values

Parameters:

collectionField - Solr field name that holds the collection values

topElement - name of the root collection to use as the response root

facetField - Solr field used for grouping/faceting within the collection

ignore - list of collection names to exclude from the result

Returns:

the IIIF Presentation v2 Collection rooted at the given top-level element, with sub-collections grouped by the facet field

Throws:

IndexUnreachableException - if any.

URISyntaxException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException - if the topElement is not a collection

getCollectionBuilder

public CollectionBuilder getCollectionBuilder()

Getter for the field collectionBuilder.

Returns:

the CollectionBuilder instance used to build IIIF collection responses