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

Class CollectionBuilder

java.lang.Object

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

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

public class CollectionBuilder
extends AbstractBuilder

CollectionBuilder class.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	CONTAINED_WORKS_QUERY_FIELDS	Required field to create manifest stubs for works in collection
static final String	RSS_FEED_FORMAT	Constant RSS_FEED_FORMAT="Rss feed"
static final String	RSS_FEED_LABEL	Constant RSS_FEED_LABEL="Rss feed"

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

REQUIRED_SOLR_FIELDS, urls

Constructor Summary

Constructors

Constructor	Description
CollectionBuilder(AbstractApiUrlManager apiUrlManager)	Constructor for CollectionBuilder.

Method Summary

Modifier and Type	Method	Description
void	addContainedWorks(String collectionField, String topElement, de.intranda.api.iiif.presentation.v2.Collection2 collection)	addContainedWorks.
void	addTagListService(de.intranda.api.iiif.presentation.v2.Collection2 collection, String collectionField, String facetField, String label)	Add a taglist service to the collection and all subcollections.
de.intranda.api.iiif.presentation.v2.Collection2	createCollection(CollectionView collectionView, HierarchicalBrowseDcElement baseElement, URI uri)	createCollection.
String	createCollectionQuery(String collectionField, String topElement)	createCollectionQuery.
CollectionView	createCollectionView(String collectionField, String facetField, String splittingChar)
de.intranda.api.iiif.presentation.v2.Collection2	generateCollection(String collectionField, String topElement, String facetField, String splittingChar, List<String> ignoreCollections)	generateCollection.
CollectionView	getCollectionView(String collectionField, String groupingField, String splittingChar)	getCollectionView.
String	getFacetField(String collectionField)	getFacetField.

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, 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

CONTAINED_WORKS_QUERY_FIELDS

public static final String[] CONTAINED_WORKS_QUERY_FIELDS

Required field to create manifest stubs for works in collection

RSS_FEED_LABEL

public static final String RSS_FEED_LABEL

Constant RSS_FEED_LABEL="Rss feed"

See Also:

• Constant Field Values

RSS_FEED_FORMAT

public static final String RSS_FEED_FORMAT

Constant RSS_FEED_FORMAT="Rss feed"

See Also:

• Constant Field Values

Constructor Details

CollectionBuilder

public CollectionBuilder(AbstractApiUrlManager apiUrlManager)
                  throws URISyntaxException

Constructor for CollectionBuilder.

Parameters:

apiUrlManager -

Throws:

URISyntaxException - if any.

Method Details

generateCollection

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

generateCollection.

Parameters:

collectionField - a String object.

topElement - a String object.

splittingChar - a String object.

facetField - A SOLR field which values are requested for all records within the collection and stored within the collection for later use

ignoreCollections -

Returns:

a Collection2 object.

Throws:

IndexUnreachableException - if any.

URISyntaxException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException - if the top element is not empty and is not a collection

addContainedWorks

public void addContainedWorks(String collectionField,
 String topElement,
 de.intranda.api.iiif.presentation.v2.Collection2 collection)
                       throws PresentationException,
IndexUnreachableException,
URISyntaxException

addContainedWorks.

Parameters:

collectionField - a String object.

topElement - a String object.

collection - a Collection2 object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

URISyntaxException - if any.

createCollectionQuery

public String createCollectionQuery(String collectionField,
 String topElement)

createCollectionQuery.

Parameters:

collectionField - a String object.

topElement - a String object.

Returns:

a String object.

createCollection

public de.intranda.api.iiif.presentation.v2.Collection2 createCollection(CollectionView collectionView,
 HierarchicalBrowseDcElement baseElement,
 URI uri)
                                                                  throws URISyntaxException,
ViewerConfigurationException

createCollection.

Parameters:

baseElement - a HierarchicalBrowseDcElement object.

collectionView - a CollectionView object.

uri - a URI object.

Returns:

a Collection2 object.

Throws:

URISyntaxException - if any.

ViewerConfigurationException - if any.

addTagListService

public void addTagListService(de.intranda.api.iiif.presentation.v2.Collection2 collection,
 String collectionField,
 String facetField,
 String label)
                       throws IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Add a taglist service to the collection and all subcollections. The taglist service provides a list of

Parameters:

collection -

collectionField -

facetField -

label -

Throws:

IndexUnreachableException

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

getCollectionView

public CollectionView getCollectionView(String collectionField,
 String groupingField,
 String splittingChar)
                                 throws IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollectionView.

Parameters:

collectionField - a String object.

groupingField - a String object.

splittingChar - a String object.

Returns:

a CollectionView object.

Throws:

IndexUnreachableException - if any.

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

createCollectionView

public CollectionView createCollectionView(String collectionField,
 String facetField,
 String splittingChar)
                                    throws IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Parameters:

collectionField -

facetField - A SOLR field which values are queried and kept in the collectionView for later use

splittingChar -

Returns:

CollectionView

Throws:

IndexUnreachableException

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

getFacetField

public String getFacetField(String collectionField)

getFacetField.

Parameters:

collectionField - a String object.

Returns:

a String object.