Package io.goobi.viewer.model.iiif.discovery

Class ActivityCollectionBuilder

java.lang.Object

io.goobi.viewer.model.iiif.discovery.ActivityCollectionBuilder

public class ActivityCollectionBuilder
extends Object

Builder for both OrderedCollection and OrderedCollectionPage of Acvitities for the IIIF Discovery API.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
ActivityCollectionBuilder(AbstractApiUrlManager apiUrlManager)

Method Summary

Modifier and Type	Method	Description
de.intranda.api.iiif.discovery.OrderedCollection<de.intranda.api.iiif.discovery.Activity>	buildCollection()	Creates a An OrderedCollection of Acvitities, linking to the first and last contained OrderedCollectionPage as well as counting the total number of Activities
de.intranda.api.iiif.discovery.OrderedCollectionPage<de.intranda.api.iiif.discovery.Activity>	buildPage(int pageNo)	Creates An OrderedCollection of Activities, i.e.
int	getActivitiesPerPage()	Get the number of activities per page as defined by Configuration#getIIIFDiscoveryAvtivitiesPerPage()
URI	getCollectionURI()	Get the URI for the collection request
int	getNumActivities()	Get the total number of Activities in the collection
URI	getPageURI(int no)	Get the URI to request a specific collection page
LocalDateTime	getStartDate()	Get the earliest date of Activities which may be contained in the collection
ActivityCollectionBuilder	setStartDate(LocalDateTime startDate)	Set the earliest date of Activities to be included in this collection.

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityCollectionBuilder

public ActivityCollectionBuilder(AbstractApiUrlManager apiUrlManager)

Method Details

buildCollection

public de.intranda.api.iiif.discovery.OrderedCollection<de.intranda.api.iiif.discovery.Activity> buildCollection()
                                                                                                          throws PresentationException,
IndexUnreachableException

Creates a An OrderedCollection of Acvitities, linking to the first and last contained OrderedCollectionPage as well as counting the total number of Activities

Returns:

An OrderedCollection

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

buildPage

public de.intranda.api.iiif.discovery.OrderedCollectionPage<de.intranda.api.iiif.discovery.Activity> buildPage(int pageNo)
                                                                                                        throws PresentationException,
IndexUnreachableException

Creates An OrderedCollection of Activities, i.e. a partial list of Activities. Which Activities are contained within the page depends on the given pageNo as well as the configured number of entries per page defined by Configuration#getIIIFDiscoveryAvtivitiesPerPage()

Parameters:

pageNo - The number of this page, beginning with 0

Returns:

An OrderedCollectionPage

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

setStartDate

public ActivityCollectionBuilder setStartDate(LocalDateTime startDate)
                                       throws PresentationException,
IndexUnreachableException

Set the earliest date of Activities to be included in this collection.

Parameters:

startDate - the earliest date of Activities to be included in this collection. If null, Activities are not filtered by date which is the default

Returns:

The Builder itself

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getStartDate

public LocalDateTime getStartDate()

Get the earliest date of Activities which may be contained in the collection

Returns:

the earliest date of Activities which may be contained in the collection. May return null if no startDate is specified

getActivitiesPerPage

public int getActivitiesPerPage()

Get the number of activities per page as defined by Configuration#getIIIFDiscoveryAvtivitiesPerPage()

Returns:

the number of activities per page as defined by Configuration#getIIIFDiscoveryAvtivitiesPerPage()

getNumActivities

public int getNumActivities()
                     throws PresentationException,
IndexUnreachableException

Get the total number of Activities in the collection

Returns:

the total number of Activities in the collection

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCollectionURI

public URI getCollectionURI()

Get the URI for the collection request

Returns:

the URI for the collection request

getPageURI

public URI getPageURI(int no)

Get the URI to request a specific collection page

Parameters:

no - the page number

Returns:

the URI to request a specific collection page