Package io.goobi.viewer.model.viewer

Class ViewManager

java.lang.Object

io.goobi.viewer.model.viewer.ViewManager

All Implemented Interfaces:

Serializable

public class ViewManager
extends Object
implements Serializable

Holds information about the currently open record (structure, pages, etc.). Used to reduced the size of ActiveDocumentBean.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ViewManager(StructElement topDocument, IPageLoader pageLoader, String currentDocumentIddoc, String logId, String mimeType, ImageDeliveryBean imageDeliveryBean)	Constructor for ViewManager.

Method Summary

Modifier and Type	Method	Description
String	addToTranskribusAction(boolean login)	addToTranskribusAction.
protected PageNavigation	calculateCurrentPageNavigation(PageType pageType)
CalendarView	createCalendarView()	createCalendarView.
static ViewManager	createViewManager(String pi, boolean loadPages)	Creates an instance of ViewManager loaded with the record with the given identifier.
void	dropdownAction(jakarta.faces.event.ValueChangeEvent event)	dropdownAction.
String	firstImage()	firstImage.
void	generatePageRangePdf()
List<PhysicalElement>	getAllPages()	Returns all pages in their correct order.
String	getAltoUrl()	Return the url to a REST service delivering the alto file of the given page as xml
String	getAltoUrlForAllPages()	Return the url to a REST service delivering all alto files of a work as zip
String	getAnchorDocumentIddoc()
String	getAnchorMetsResolverUrl()	getAnchorMetsResolverUrl.
String	getAnchorPi()	If the current record is a volume, returns the PI of the anchor record.
StructElement	getAnchorStructElement()
String	getAnchorTitle()	Returns the main title of the current volume's anchor, if available.
String	getArchiveEntryIdentifier()
List<ArchiveEntry>	getArchiveHierarchyForIdentifier(String identifier)
org.apache.commons.lang3.tuple.Pair<Optional<String>,Optional<String>>	getArchiveTreeNeighbours()
String	getArchiveUrlForIdentifier(String identifier)
CalendarView	getCalendarView()	Getter for the field calendarView.
CitationProcessorWrapper	getCitationProcessorWrapper()
String	getCitationStringHtml()
String	getCitationStringPlain()
String	getCitationStyle()
String	getCiteLinkDocstruct()
String	getCiteLinkPage()	getCiteLinkPage.
String	getCiteLinkWork()	getCiteLinkWork.
List<LabeledLink>	getContentDownloadLinksForWork()	Returns a list of original content file download links (name+url) for the current document.
String	getContextObject()	Returns the ContextObject value for a COinS element (generated using metadata from currentDocument).
CopyrightIndicatorLicense	getCopyrightIndicatorLicense()
List<CopyrightIndicatorStatus>	getCopyrightIndicatorStatuses()
String	getCopyrightIndicatorStatusName()
String	getCssClass()
List<StructElementStub>	getCurrentDocumentHierarchy()	getCurrentDocumentHierarchy.
int	getCurrentHeight()	getCurrentHeight.
String	getCurrentImageInfo(PageType pageType)	getCurrentImageInfo.
String	getCurrentImageInfoCrowd()	getCurrentImageInfoCrowd.
String	getCurrentImageInfoFullscreen()	getCurrentImageInfoFullscreen.
String	getCurrentImageLabel()	Returns the ORDERLABEL value for the current page.
int	getCurrentImageOrder()	currentImageOrder.
int	getCurrentImageOrderForPaginator()	Getter for the paginator or the direct page number input field
String	getCurrentImageUrl()	getCurrentImageUrl.
String	getCurrentImageUrl(int size)	getCurrentImageUrl.
String	getCurrentImageUrl(PageType view)	getCurrentImageUrl.
Optional<PhysicalElement>	getCurrentLeftPage()
String	getCurrentMasterImageUrl()	Deprecated.
String	getCurrentObjectUrl()	getCurrentObjectUrl.
PhysicalElement	getCurrentPage()	getCurrentPage.
int	getCurrentPageSourceIndex()	getCurrentPageSourceIndex.
Optional<PhysicalElement>	getCurrentRightPage()
int	getCurrentRotate()	getCurrentRotate.
List<List<String>>	getCurrentSearchResultCoords()	getCurrentSearchResultCoords.
StructElement	getCurrentStructElement()	Getter for the field currentStructElement.
String	getCurrentStructElementIddoc()	Getter for the field currentStructElementIddoc.
int	getCurrentThumbnailPage()	Getter for the field currentThumbnailPage.
User	getCurrentUser()	Retrieves the current User from the session, if exists.
int	getCurrentWidth()	getCurrentWidth.
protected PageNavigation	getDefaultPageNavigation(PageType pageType)
String	getDenkxwebResolverUrl()	Deprecated. Use ViewManager.getSourceFileResolverUrl()
String	getDocumentTitle(StructElement document)	getDocumentTitle.
static List<DownloadOption>	getDownloadOptionsForImage(List<DownloadOption> configuredOptions, Dimension origImageSize, Dimension configuredMaxSize, String imageFilename)
List<DownloadOption>	getDownloadOptionsForPage(PhysicalElement page)
List<PhysicalResource>	getDownloadResources()
List<SelectPageItem>	getDropdownFulltext()	Getter for the field dropdownFulltext.
List<String>	getDropdownFulltextAsJson()
List<SelectPageItem>	getDropdownPages()	Getter for the field dropdownPages.
List<String>	getDropdownPagesAsJson()
String	getDropdownSelected()	Getter for the field dropdownSelected.
String	getDublinCoreMetaTags()	Generates DC meta tags for the head of a HTML page.
String	getDublinCoreResolverUrl()	Deprecated. Use ViewManager.getSourceFileResolverUrl()
String	getExternalDownloadUrl()	Returns an external download URL, if once exists in MD2_DOWNLOAD_URL.
List<String>	getExternalResourceUrls()
Map<String,List<String>>	getFilenamesByMimeType(boolean localFilesOnly)
int	getFirstDisplayedThumbnailIndex()	getFirstDisplayedThumbnailIndex.
PhysicalElement	getFirstPage()	getFirstPage.
int	getFirstPageOrder()
PageOrientation	getFirstPageOrientation()	Getter for the field firstPageOrientation.
String	getFirstPdfPage()	Getter for the field firstPdfPage.
String	getFulltext()	Deprecated. Use PhysicalElement.getFullText()
String	getFulltext(boolean escapeHtml, String language)	Deprecated. Use PhysicalElement.getFullText()
String	getFulltextMimeType()
String	getFulltextMimeType(String language)
String	getFulltextUrl()	Return the url to a REST service delivering the fulltext as plain text of the given page
String	getFulltextUrlForAllPages()	Return the url to a REST service delivering all plain text of a work as zip
String	getHighwirePressMetaTags()	getHighwirePressMetaTags.
static String	getImageFormat(String format, String imageFilename)	return the current image format if argument is 'MASTER', or the argument itself otherwise
Map<Integer,String>	getImageInfos(PageType pageType)
String	getImageInfosAsJson(PageType pageType)
int	getImagesCount()	getImagesCount.
List<PhysicalElement>	getImagesSection()	Returns the PhysicalElements for the current thumbnail page using the configured number of thumbnails per page;
protected List<PhysicalElement>	getImagesSection(int thumbnailsPerPage)	Returns the PhysicalElements for the current thumbnail page.
String	getImagesSizeThumbnail()	getImagesSizeThumbnail.
int	getLastPageOrder()
String	getLastPdfPage()	Getter for the field lastPdfPage.
String	getLidoResolverUrl()	Deprecated. Use ViewManager.getSourceFileResolverUrl()
String	getLinkForDFGViewer()	getLinkForDFGViewer.
protected LabeledLink	getLinkToDownloadFile(String filename)
String	getLogId()	Getter for the field logId.
String	getMasterImageUrl(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale, PhysicalElement page)	getCurrentMasterImageUrl.
String	getMasterImageUrlForDownload(String boxSizeInPixel)	Deprecated.
String	getMetsResolverUrl()	Deprecated. Use ViewManager.getSourceFileResolverUrl()
String	getMimeType()	Getter for the field mimeType.
String	getMimeTypeViaFileName(String filename)
PhysicalElement	getNextPrevPage(int step)
String	getOaiDcUrl()	getOaiDcUrl.
String	getOaiEseUrl()	getOaiEseUrl.
String	getOaiMarcUrl()	getOaiMarcUrl.
String	getOpacUrl()	Getter for the field opacUrl.
Optional<PhysicalElement>	getPage(int order)	Returns the page with the given order number from the page loader, if exists.
Long	getPageCountWithAlto()
long	getPageCountWithFulltext()
String	getPageDownloadUrl(DownloadOption option, PhysicalElement page)	getPageDownloadUrl.
IPageLoader	getPageLoader()	Getter for the field pageLoader.
PageNavigation	getPageNavigation()
List<Integer>	getPageRangeAroundPage(int pageOrder, int range, boolean fillToSize)	Returns an integer list such that the 'pageOrder' is contained in the list the list contains (2*range)+1 consecutive numbers, or all page numbers of the current record if it is less than that the first number is not less than the first image order the last number is not larger than the last image order the 'pageOrder' is as far in the middle of the list as possible without violating any of the other points Used int thumbnailPaginator.xhtml to calculate the pages to display.
List<PhysicalElement>	getPagesForMediaType(String type)
String	getPageUrl(jakarta.faces.model.SelectItem item)
String	getPdfDownloadLink()	Returns the pdf download link for the current document
String	getPdfDownloadLink(List<List<String>> queryParams)	Returns the pdf download link for the current document, allowing to attach a number of query parameters to it
String	getPdfPageDownloadLink()	Returns the pdf download link for the current page
String	getPdfPartDownloadLink()	Returns the pdf download link for a pdf of all pages from this.firstPdfPage to this.lastPdfPage (inclusively)
String	getPdfStructDownloadLink()	Returns the pdf download link for the current struct element
String	getPdfStructDownloadLink(List<List<String>> queryParams)	Returns the pdf download link for the current struct element, allowing to add a number of query parameters to it
String	getPi()	Getter for the field pi.
int	getRepresentativeHeight()	getRepresentativeHeight.
String	getRepresentativeImageInfo()	getRepresentativeImageInfo.
String	getRepresentativeImageUrl()	getRepresentativeImageUrl.
String	getRepresentativeImageUrl(int width, int height)
PhysicalElement	getRepresentativePage()	Getter for the field representativePage.
int	getRepresentativeWidth()	getRepresentativeWidth.
List<CitationLink>	getSidebarWidgetUsageCitationLinksForLevel(String levelName)
String	getSourceFileResolverUrl()
String	getTeiUrl()	Return the url to a REST service delivering the fulltext of the current page as TEI
String	getTeiUrlForAllPages()	Return the url to a REST service delivering a TEI document containing the text of all pages
String	getTeiUrlForAllPages(String language)
String	getThumbnailUrlForDownload(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale, PhysicalElement page)	getCurrentThumbnailUrlForDownload.
TOC	getToc()
String	getTopDocumentTitle()	getTopDocumentTitle.
StructElement	getTopStructElement()	Getter for the field topStructElement.
String	getTopStructElementIddoc()	Getter for the field topStructElementIddoc.
List<String>	getVersionHistory()	Getter for the field versionHistory.
String	getVolumeTitle()	Returns the main title of the current volume.
String	getWatermarkUrl()	getWatermarkUrl.
String	getWatermarkUrl(String pageType)	getWatermarkUrl.
int	getZoomSlider()	Getter for the field zoomSlider.
boolean	hasNextThumbnailSection()	hasNextThumbnailSection.
boolean	hasPrerenderedPagePdfs()
boolean	hasPreviousThumbnailSection()	hasPreviousThumbnailSection.
boolean	isAccessPermission(String privilege)
boolean	isAccessPermissionExternalResources()
boolean	isAccessPermissionPdf()	isAccessPermissionPdf.
Boolean	isAllowUserComments()
boolean	isAltoAvailableForWork()	isAltoAvailableForWork.
boolean	isBelowFulltextThreshold()	isBelowFulltextThreshold.
boolean	isBornDigital()	Deprecated. replc
boolean	isDisplayCalendarViewLink()
boolean	isDisplayCiteLinkDocstruct()	isDisplayCiteLinkDocstruct.
boolean	isDisplayCiteLinkPage()	isDisplayCiteLinkPage.
boolean	isDisplayCiteLinkWork()	isDisplayCiteLinkWork.
boolean	isDisplayContentDownloadMenu()	Returns true if original content download has been enabled in the configuration and there are files in the original content folder for this record.
boolean	isDisplayExternalFulltextLink()
boolean	isDisplayExternalResolverLink()
boolean	isDisplayFulltextViewLink()
boolean	isDisplayMetadataPdfLink()	isDisplayMetadataPdfLink.
boolean	isDisplayMetadataViewLink()
boolean	isDisplayNerViewLink()
boolean	isDisplayObjectViewLink()
boolean	isDisplayThumbnailViewLink()
boolean	isDisplayTocViewLink()
boolean	isDoublePageMode()	isDoublePageMode.
boolean	isDoublePageNavigationEnabled(PageType pageType)
boolean	isFilesOnly()	isFilesOnly.
boolean	isFulltextAvailableForWork()	isFulltextAvailableForWork.
boolean	isFulltextFromTEI()
boolean	isHasDownloadResources()
boolean	isHasExternalResources()
boolean	isHasPages()	isHasPages.
boolean	isHasUrns()	isHasUrns.
boolean	isHasVersionHistory()	isHasVersionHistory.
boolean	isHasVolumes()	isHasVolumes.
boolean	isListAllVolumesInTOC()	Defines the criteria whether to list all remaining volumes in the TOC if the current record is a volume.
boolean	isMetadataViewOnly()	Convenience method that checks whether only the metadata view link is displayed for this record (i.e. criteria for all other links are not met).
boolean	isMultiPageRecord()	isMultiPageRecord.
boolean	isPdfPartDownloadLinkEnabled()	isPdfPartDownloadLinkEnabled.
boolean	isRecordAddedToTranskribus(TranskribusSession session)	isRecordAddedToTranskribus.
boolean	isRecordHasImages()
boolean	isRecordHasTEIFiles()
boolean	isSequenceMode()
boolean	isTeiAvailableForWork()	isTeiAvailableForWork.
String	lastImage()	lastImage.
String	nextImage()	nextImage.
void	nextThumbnailSection()	nextThumbnailSection.
String	prevImage()	prevImage.
void	previousThumbnailSection()	previousThumbnailSection.
void	resetAccessPermissionPdf()	Reset the pdf access permissions.
void	resetAllowUserComments()	Reset the permissions for writing user comments.
String	resetImage()	resetImage.
String	rotateLeft()	rotateLeft.
String	rotateRight()	rotateRight.
static Dimension	scaleToHeight(Dimension imageSize, int scaledHeight)	scaleToHeight.
static Dimension	scaleToWidth(Dimension imageSize, int scaledWidth)	scaleToWidth.
void	setAllowUserComments(Boolean allowUserComments)
void	setCitationProcessorWrapper(CitationProcessorWrapper citationProcessorWrapper)
void	setCitationStyle(String citationStyle)
void	setCurrentImageOrder(int currentImageOrder)	currentPageOrder.
void	setCurrentImageOrderForPaginator(int currentImageOrder)	Setter for the direct page number input field
void	setCurrentImageOrderPerScript()
void	setCurrentImageOrderString(String currentImageOrderString)	Main method for setting the current page(s) in this ViewManager.
void	setCurrentStructElement(StructElement currentStructElement)	Setter for the field currentStructElement.
void	setCurrentStructElementtIddoc(String currentStructElementIddoc)	Setter for the field currentStructElementIddoc.
void	setCurrentThumbnailPage(int currentThumbnailPage)	Setter for the field currentThumbnailPage.
void	setDoublePageMode(boolean doublePageMode)	Setter for the field doublePageMode.
void	setDropdownSelected(String dropdownSelected)	Setter for the field dropdownSelected.
void	setFirstPageOrientation(PageOrientation firstPageOrientation)	Setter for the field firstPageOrientation.
void	setFirstPdfPage(String firstPdfPage)	Setter for the field firstPdfPage.
void	setLastPdfPage(String lastPdfPage)	Setter for the field lastPdfPage.
void	setLogId(String logId)	Setter for the field logId.
void	setPageLoader(IPageLoader loader)	Setter for the field pageLoader.
protected void	setPageNavigation(PageNavigation navigation)
void	setToc(TOC toc)
void	setTopStructElement(StructElement topStructElement)	setTopStructElement.
void	setZoomSlider(int zoomSlider)	Setter for the field zoomSlider.
boolean	showImageThumbnailGallery(PageType pageType)
void	togglePageOrientation()	togglePageOrientation.
void	updateDropdownSelected()	updateDropdownSelected.
void	updatePageNavigation(PageType pageType)
boolean	useTiles()	useTiles.
boolean	useTilesFullscreen()	useTilesFullscreen.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewManager

public ViewManager(StructElement topDocument,
 IPageLoader pageLoader,
 String currentDocumentIddoc,
 String logId,
 String mimeType,
 ImageDeliveryBean imageDeliveryBean)
            throws IndexUnreachableException,
PresentationException

Constructor for ViewManager.

Parameters:

topDocument - a StructElement object.

pageLoader - a IPageLoader object.

currentDocumentIddoc - a long.

logId - a String object.

mimeType - a String object.

imageDeliveryBean - a ImageDeliveryBean object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

Method Details

getDefaultPageNavigation

protected PageNavigation getDefaultPageNavigation(PageType pageType)

getArchiveTreeNeighbours

public org.apache.commons.lang3.tuple.Pair<Optional<String>,Optional<String>> getArchiveTreeNeighbours()

getArchiveHierarchyForIdentifier

public List<ArchiveEntry> getArchiveHierarchyForIdentifier(String identifier)

getArchiveUrlForIdentifier

public String getArchiveUrlForIdentifier(String identifier)

getPageUrl

public String getPageUrl(jakarta.faces.model.SelectItem item)

createCalendarView

public CalendarView createCalendarView()
                                throws IndexUnreachableException,
PresentationException

createCalendarView.

Returns:

a CalendarView object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getRepresentativeImageInfo

public String getRepresentativeImageInfo()
                                  throws IndexUnreachableException,
DAOException,
PresentationException,
ViewerConfigurationException

getRepresentativeImageInfo.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

getImageInfos

public Map<Integer,String> getImageInfos(PageType pageType)
                                  throws IndexUnreachableException,
DAOException

Throws:

IndexUnreachableException

DAOException

getImageInfosAsJson

public String getImageInfosAsJson(PageType pageType)
                           throws IndexUnreachableException,
DAOException

Throws:

IndexUnreachableException

DAOException

getCurrentImageInfo

public String getCurrentImageInfo(PageType pageType)
                           throws IndexUnreachableException,
DAOException

getCurrentImageInfo.

Parameters:

pageType - a PageType object.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentLeftPage

public Optional<PhysicalElement> getCurrentLeftPage()

Returns:

Optional

getCurrentRightPage

public Optional<PhysicalElement> getCurrentRightPage()

Returns:

Optional

getCurrentImageInfoFullscreen

public String getCurrentImageInfoFullscreen()
                                     throws IndexUnreachableException,
DAOException

getCurrentImageInfoFullscreen.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentImageInfoCrowd

public String getCurrentImageInfoCrowd()
                                throws IndexUnreachableException,
DAOException

getCurrentImageInfoCrowd.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getWatermarkUrl

public String getWatermarkUrl()
                       throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

getWatermarkUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getWatermarkUrl

public String getWatermarkUrl(String pageType)
                       throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

getWatermarkUrl.

Parameters:

pageType - a String object.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCurrentImageUrl

public String getCurrentImageUrl()
                          throws ViewerConfigurationException,
IndexUnreachableException,
DAOException

getCurrentImageUrl.

Returns:

a String object.

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getCurrentObjectUrl

public String getCurrentObjectUrl()
                           throws IndexUnreachableException,
DAOException

getCurrentObjectUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentImageUrl

public String getCurrentImageUrl(PageType view)
                          throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

getCurrentImageUrl.

Parameters:

view - a PageType object.

Returns:

the iiif url to the image in a configured size

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCurrentImageUrl

public String getCurrentImageUrl(int size)
                          throws IndexUnreachableException,
DAOException

getCurrentImageUrl.

Parameters:

size - a int.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentMasterImageUrl

@Deprecated(since="24.10")
public String getCurrentMasterImageUrl()
                                throws IndexUnreachableException,
DAOException

Deprecated.

getCurrentMasterImageUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getMasterImageUrl

public String getMasterImageUrl(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale,
 PhysicalElement page)
                         throws IndexUnreachableException,
DAOException

getCurrentMasterImageUrl.

Parameters:

scale - a Scale object.

page -

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getThumbnailUrlForDownload

public String getThumbnailUrlForDownload(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale,
 PhysicalElement page)
                                  throws IndexUnreachableException,
DAOException

getCurrentThumbnailUrlForDownload.

Parameters:

scale - a Scale object.

page -

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getPageDownloadUrl

public String getPageDownloadUrl(DownloadOption option,
 PhysicalElement page)
                          throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

getPageDownloadUrl.

Parameters:

option -

page -

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException

getDownloadOptionsForImage

public static List<DownloadOption> getDownloadOptionsForImage(List<DownloadOption> configuredOptions,
 Dimension origImageSize,
 Dimension configuredMaxSize,
 String imageFilename)

Parameters:

configuredOptions -

origImageSize -

configuredMaxSize -

imageFilename -

Returns:

List

getDownloadOptionsForPage

public List<DownloadOption> getDownloadOptionsForPage(PhysicalElement page)
                                               throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Parameters:

page -

Returns:

List

Throws:

IndexUnreachableException

DAOException

ViewerConfigurationException

getImageFormat

public static String getImageFormat(String format,
 String imageFilename)

return the current image format if argument is 'MASTER', or the argument itself otherwise

Parameters:

format -

imageFilename -

Returns:

Image format

getMasterImageUrlForDownload

@Deprecated(since="24.10")
public String getMasterImageUrlForDownload(String boxSizeInPixel)
                                    throws IndexUnreachableException,
DAOException

Deprecated.

getMasterImageUrlForDownload.

Parameters:

boxSizeInPixel -

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentSearchResultCoords

public List<List<String>> getCurrentSearchResultCoords()
                                                throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

getCurrentSearchResultCoords.

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getRepresentativeWidth

public int getRepresentativeWidth()
                           throws PresentationException,
IndexUnreachableException,
DAOException

getRepresentativeWidth.

Returns:

a int.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getRepresentativeHeight

public int getRepresentativeHeight()
                            throws PresentationException,
IndexUnreachableException,
DAOException

getRepresentativeHeight.

Returns:

a int.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getCurrentWidth

public int getCurrentWidth()
                    throws IndexUnreachableException,
DAOException

getCurrentWidth.

Returns:

a int.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentHeight

public int getCurrentHeight()
                     throws IndexUnreachableException,
DAOException

getCurrentHeight.

Returns:

a int.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getRepresentativeImageUrl

public String getRepresentativeImageUrl()
                                 throws IndexUnreachableException,
PresentationException,
DAOException

getRepresentativeImageUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

getRepresentativeImageUrl

public String getRepresentativeImageUrl(int width,
 int height)
                                 throws IndexUnreachableException,
PresentationException,
DAOException

Parameters:

width -

height -

Returns:

URL to the representative image as String

Throws:

IndexUnreachableException

PresentationException

DAOException

scaleToWidth

public static Dimension scaleToWidth(Dimension imageSize,
 int scaledWidth)

scaleToWidth.

Parameters:

imageSize - a Dimension object.

scaledWidth - a int.

Returns:

a Dimension object.

scaleToHeight

public static Dimension scaleToHeight(Dimension imageSize,
 int scaledHeight)

scaleToHeight.

Parameters:

imageSize - a Dimension object.

scaledHeight - a int.

Returns:

a Dimension object.

getCurrentUser

public User getCurrentUser()

Retrieves the current User from the session, if exists.

Returns:

The current User; null of not logged in.

rotateLeft

public String rotateLeft()

rotateLeft.

Returns:

a String object.

rotateRight

public String rotateRight()

rotateRight.

Returns:

a String object.

resetImage

public String resetImage()

resetImage.

Returns:

a String object.

isHasUrns

public boolean isHasUrns()
                  throws PresentationException,
IndexUnreachableException

isHasUrns.

Returns:

true if this record contains URN or IMAGEURN fields; false otherwise

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

isHasVolumes

public boolean isHasVolumes()

isHasVolumes.

Returns:

true if this is an anchor record and has indexed volumes; false otherwise

isHasPages

public boolean isHasPages()
                   throws IndexUnreachableException

isHasPages.

Returns:

true if record contains pages; false otherwise

Throws:

IndexUnreachableException - if any.

isFilesOnly

public boolean isFilesOnly()
                    throws IndexUnreachableException,
DAOException

isFilesOnly.

Returns:

true if record or first child or first page have an application mime type; false otherwise

Throws:

IndexUnreachableException - if any.

DAOException - if any.

isBornDigital

@Deprecated(since="25.02")
public boolean isBornDigital()
                      throws IndexUnreachableException,
DAOException

Deprecated.

replc

Convenience method for identifying born digital material records.

Returns:

true if record is born digital material (no scanned images); false otherwise

Throws:

IndexUnreachableException - if any.

DAOException - if any.

isHasExternalResources

public boolean isHasExternalResources()
                               throws IndexUnreachableException

Throws:

IndexUnreachableException

isHasDownloadResources

public boolean isHasDownloadResources()
                               throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getDownloadResources

public List<PhysicalResource> getDownloadResources()
                                            throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

isListAllVolumesInTOC

public boolean isListAllVolumesInTOC()
                              throws IndexUnreachableException,
DAOException

Defines the criteria whether to list all remaining volumes in the TOC if the current record is a volume.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getAllPages

public List<PhysicalElement> getAllPages()
                                  throws IndexUnreachableException,
DAOException

Returns all pages in their correct order. Used for e-publications.

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentPage

public PhysicalElement getCurrentPage()

getCurrentPage.

Returns:

a PhysicalElement object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getNextPrevPage

public PhysicalElement getNextPrevPage(int step)
                                throws IndexUnreachableException

Parameters:

step -

Returns:

PhysicalElement

Throws:

IndexUnreachableException

getPage

public Optional<PhysicalElement> getPage(int order)

Returns the page with the given order number from the page loader, if exists.

Parameters:

order - a int.

Returns:

requested page if exists; null otherwise.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getRepresentativePage

public PhysicalElement getRepresentativePage()
                                      throws PresentationException,
IndexUnreachableException,
DAOException

Getter for the field representativePage.

Returns:

a PhysicalElement object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getFirstPage

public PhysicalElement getFirstPage()
                             throws IndexUnreachableException,
DAOException

getFirstPage.

Returns:

a PhysicalElement object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCurrentImageOrderForPaginator

public int getCurrentImageOrderForPaginator()

Getter for the paginator or the direct page number input field

Returns:

currentImageNo

setCurrentImageOrderForPaginator

public void setCurrentImageOrderForPaginator(int currentImageOrder)
                                      throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

Setter for the direct page number input field

Parameters:

currentImageOrder - a int.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

IDDOCNotFoundException

getCurrentImageOrder

public int getCurrentImageOrder()

currentImageOrder.

Returns:

the currentImageOrder

setCurrentImageOrderPerScript

public void setCurrentImageOrderPerScript()
                                   throws NumberFormatException,
IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

Throws:

NumberFormatException

IndexUnreachableException

PresentationException

IDDOCNotFoundException

setCurrentImageOrder

public void setCurrentImageOrder(int currentImageOrder)
                          throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

currentPageOrder.

Parameters:

currentImageOrder - the currentImageOrder to set

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

RecordNotFoundException

PresentationException

IDDOCNotFoundException

setPageNavigation

protected void setPageNavigation(PageNavigation navigation)

updatePageNavigation

public void updatePageNavigation(PageType pageType)

calculateCurrentPageNavigation

protected PageNavigation calculateCurrentPageNavigation(PageType pageType)

setCurrentImageOrderString

public void setCurrentImageOrderString(String currentImageOrderString)
                                throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

Main method for setting the current page(s) in this ViewManager. If the given String cannot be parsed to an integer the current image order is set to 1

Parameters:

currentImageOrderString - A string containing a single page number or a range of two pages

Throws:

IndexUnreachableException

PresentationException

IDDOCNotFoundException

getCurrentImageLabel

public String getCurrentImageLabel()
                            throws IndexUnreachableException,
DAOException

Returns the ORDERLABEL value for the current page.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

nextImage

public String nextImage()
                 throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

nextImage.

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

IDDOCNotFoundException

prevImage

public String prevImage()
                 throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

prevImage.

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

IDDOCNotFoundException

firstImage

public String firstImage()
                  throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

firstImage.

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

IDDOCNotFoundException

lastImage

public String lastImage()
                 throws IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

lastImage.

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

IDDOCNotFoundException

isMultiPageRecord

public boolean isMultiPageRecord()
                          throws IndexUnreachableException

isMultiPageRecord.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

getImagesCount

public int getImagesCount()
                   throws IndexUnreachableException

getImagesCount.

Returns:

Integer

Throws:

IndexUnreachableException - if any.

getLastPageOrder

public int getLastPageOrder()

Returns:

Last page number

getFirstPageOrder

public int getFirstPageOrder()

Returns:

First page number

getDropdownPages

public List<SelectPageItem> getDropdownPages()

Getter for the field dropdownPages.

Returns:

the dropdownPages

getDropdownPagesAsJson

public List<String> getDropdownPagesAsJson()

getDropdownFulltext

public List<SelectPageItem> getDropdownFulltext()

Getter for the field dropdownFulltext.

Returns:

the dropdownPages

getDropdownFulltextAsJson

public List<String> getDropdownFulltextAsJson()

setDropdownSelected

public void setDropdownSelected(String dropdownSelected)

Setter for the field dropdownSelected.

Parameters:

dropdownSelected - the dropdownSelected to set

getDropdownSelected

public String getDropdownSelected()

Getter for the field dropdownSelected.

Returns:

the dropdownSelected

getImagesSection

public List<PhysicalElement> getImagesSection()
                                       throws IndexUnreachableException,
DAOException

Returns the PhysicalElements for the current thumbnail page using the configured number of thumbnails per page;

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getImagesSection

protected List<PhysicalElement> getImagesSection(int thumbnailsPerPage)
                                          throws IndexUnreachableException,
DAOException

Returns the PhysicalElements for the current thumbnail page.

Parameters:

thumbnailsPerPage - Length of the thumbnail list per page.

Returns:

PhysicalElements for the current thumbnail page.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getFirstDisplayedThumbnailIndex

public int getFirstDisplayedThumbnailIndex()

getFirstDisplayedThumbnailIndex.

Returns:

a int.

getCurrentThumbnailPage

public int getCurrentThumbnailPage()

Getter for the field currentThumbnailPage.

Returns:

a int.

setCurrentThumbnailPage

public void setCurrentThumbnailPage(int currentThumbnailPage)

Setter for the field currentThumbnailPage.

Parameters:

currentThumbnailPage - a int.

nextThumbnailSection

public void nextThumbnailSection()

nextThumbnailSection.

previousThumbnailSection

public void previousThumbnailSection()

previousThumbnailSection.

hasPreviousThumbnailSection

public boolean hasPreviousThumbnailSection()

hasPreviousThumbnailSection.

Returns:

a boolean.

hasNextThumbnailSection

public boolean hasNextThumbnailSection()

hasNextThumbnailSection.

Returns:

a boolean.

updateDropdownSelected

public void updateDropdownSelected()

updateDropdownSelected.

getPageNavigation

public PageNavigation getPageNavigation()

dropdownAction

public void dropdownAction(jakarta.faces.event.ValueChangeEvent event)
                    throws NumberFormatException,
IndexUnreachableException,
PresentationException,
IDDOCNotFoundException

dropdownAction.

Parameters:

event - ValueChangeEvent

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

NumberFormatException - if any.

IDDOCNotFoundException

getImagesSizeThumbnail

public String getImagesSizeThumbnail()
                              throws IndexUnreachableException

getImagesSizeThumbnail.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

getLinkForDFGViewer

public String getLinkForDFGViewer()
                           throws IndexUnreachableException

getLinkForDFGViewer.

Returns:

DFG Viewer link

Throws:

IndexUnreachableException - if any.

getMetsResolverUrl

@Deprecated(since="24.08")
public String getMetsResolverUrl()

Deprecated.

Use ViewManager.getSourceFileResolverUrl()

getMetsResolverUrl.

Returns:

METS resolver link

getLidoResolverUrl

@Deprecated(since="24.08")
public String getLidoResolverUrl()

Deprecated.

Use ViewManager.getSourceFileResolverUrl()

getLidoResolverUrl.

Returns:

a String object.

getDenkxwebResolverUrl

@Deprecated(since="24.08")
public String getDenkxwebResolverUrl()

Deprecated.

Use ViewManager.getSourceFileResolverUrl()

getDenkxwebResolverUrl.

Returns:

a String object.

getDublinCoreResolverUrl

@Deprecated(since="24.08")
public String getDublinCoreResolverUrl()

Deprecated.

Use ViewManager.getSourceFileResolverUrl()

getDublinCoreResolverUrl.

Returns:

a String object.

getSourceFileResolverUrl

public String getSourceFileResolverUrl()

Returns:

Source file resolver URL for the current record identifier

getAnchorMetsResolverUrl

public String getAnchorMetsResolverUrl()

getAnchorMetsResolverUrl.

Returns:

METS resolver URL for the anchor; null if no parent PI found (must be null, otherwise an empty link will be displayed).

getAltoUrlForAllPages

public String getAltoUrlForAllPages()
                             throws ViewerConfigurationException,
PresentationException,
IndexUnreachableException

Return the url to a REST service delivering all alto files of a work as zip

Returns:

the url to a REST service delivering all alto files of a work as zip

Throws:

ViewerConfigurationException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

getFulltextUrlForAllPages

public String getFulltextUrlForAllPages()
                                 throws ViewerConfigurationException,
PresentationException,
IndexUnreachableException

Return the url to a REST service delivering all plain text of a work as zip

Returns:

the url to a REST service delivering all plain text of a work as zip

Throws:

ViewerConfigurationException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

getTeiUrlForAllPages

public String getTeiUrlForAllPages()
                            throws ViewerConfigurationException,
IndexUnreachableException

Return the url to a REST service delivering a TEI document containing the text of all pages

Returns:

the TEI REST url

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

getTeiUrlForAllPages

public String getTeiUrlForAllPages(String language)
                            throws IndexUnreachableException

Parameters:

language -

Returns:

TEI URL for given language

Throws:

IndexUnreachableException

getTeiUrl

public String getTeiUrl()
                 throws ViewerConfigurationException,
IndexUnreachableException,
DAOException

Return the url to a REST service delivering the fulltext of the current page as TEI

Returns:

the TEI REST url

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getAltoUrl

public String getAltoUrl()
                  throws ViewerConfigurationException,
PresentationException,
IndexUnreachableException,
DAOException

Return the url to a REST service delivering the alto file of the given page as xml

Returns:

the url to a REST service delivering the alto file of the given page as xml

Throws:

ViewerConfigurationException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getFulltextUrl

public String getFulltextUrl()
                      throws ViewerConfigurationException,
PresentationException,
IndexUnreachableException,
DAOException

Return the url to a REST service delivering the fulltext as plain text of the given page

Returns:

the url to a REST service delivering the fulltext as plain text of the given page

Throws:

ViewerConfigurationException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getExternalDownloadUrl

public String getExternalDownloadUrl()

Returns an external download URL, if once exists in MD2_DOWNLOAD_URL.

Returns:

url if exists; null otherwise

getPdfDownloadLink

public String getPdfDownloadLink()
                          throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException,
URISyntaxException

Returns the pdf download link for the current document

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

URISyntaxException

getPdfDownloadLink

public String getPdfDownloadLink(List<List<String>> queryParams)
                          throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException,
URISyntaxException

Returns the pdf download link for the current document, allowing to attach a number of query parameters to it

Parameters:

queryParams -

Returns:

String

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

ViewerConfigurationException - if any.

URISyntaxException

getPdfPageDownloadLink

public String getPdfPageDownloadLink()
                              throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Returns the pdf download link for the current page

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getPdfStructDownloadLink

public String getPdfStructDownloadLink()
                                throws IndexUnreachableException,
DAOException,
ViewerConfigurationException,
PresentationException

Returns the pdf download link for the current struct element

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

PresentationException - if any.

getPdfStructDownloadLink

public String getPdfStructDownloadLink(List<List<String>> queryParams)
                                throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException,
URISyntaxException

Returns the pdf download link for the current struct element, allowing to add a number of query parameters to it

Parameters:

queryParams -

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

PresentationException - if any.

URISyntaxException

getPdfPartDownloadLink

public String getPdfPartDownloadLink()
                              throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Returns the pdf download link for a pdf of all pages from this.firstPdfPage to this.lastPdfPage (inclusively)

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

isPdfPartDownloadLinkEnabled

public boolean isPdfPartDownloadLinkEnabled()

isPdfPartDownloadLinkEnabled.

Returns:

a boolean.

resetAccessPermissionPdf

public void resetAccessPermissionPdf()

Reset the pdf access permissions. They will be evaluated again on the next call to isAccessPermissionPdf()

isAccessPermissionPdf

public boolean isAccessPermissionPdf()

isAccessPermissionPdf.

Returns:

true if record/structure PDF download is allowed; false otherwise

isAccessPermissionExternalResources

public boolean isAccessPermissionExternalResources()
                                            throws IndexUnreachableException,
DAOException,
RecordNotFoundException

Throws:

IndexUnreachableException

DAOException

RecordNotFoundException

isAccessPermission

public boolean isAccessPermission(String privilege)
                           throws IndexUnreachableException,
DAOException

Parameters:

privilege - Privilege name to check

Returns:

true if current user has the privilege for this record; false otherwise

Throws:

IndexUnreachableException

DAOException

resetAllowUserComments

public void resetAllowUserComments()

Reset the permissions for writing user comments. They will be evaluated again on the next call to isAllowUserComments()

isAllowUserComments

public Boolean isAllowUserComments()

Returns:

the allowUserComments

setAllowUserComments

public void setAllowUserComments(Boolean allowUserComments)

Parameters:

allowUserComments - the allowUserComments to set

isDisplayMetadataPdfLink

public boolean isDisplayMetadataPdfLink()

isDisplayMetadataPdfLink.

Returns:

a boolean.

isMetadataViewOnly

public boolean isMetadataViewOnly()
                           throws IndexUnreachableException,
DAOException,
PresentationException

Convenience method that checks whether only the metadata view link is displayed for this record (i.e. criteria for all other links are not met).

Returns:

true if loaded record only contains metadata and doesn't support over views; false otherwise

Throws:

DAOException

IndexUnreachableException

PresentationException

isDisplayObjectViewLink

public boolean isDisplayObjectViewLink()
                                throws IndexUnreachableException,
DAOException

Returns:

true if object view link may be displayed; false otherwise

Throws:

IndexUnreachableException

DAOException

isDisplayCalendarViewLink

public boolean isDisplayCalendarViewLink()
                                  throws IndexUnreachableException,
PresentationException

Returns:

true if calendar view link may be displayed; false otherwise

Throws:

IndexUnreachableException

PresentationException

isDisplayTocViewLink

public boolean isDisplayTocViewLink()
                             throws IndexUnreachableException,
DAOException

Returns:

true if TOC view link may be displayed; false otherwise

Throws:

IndexUnreachableException

DAOException

isDisplayThumbnailViewLink

public boolean isDisplayThumbnailViewLink()
                                   throws IndexUnreachableException,
DAOException

Returns:

true if thumbnail view link may be displayed; false otherwise

Throws:

IndexUnreachableException

DAOException

isDisplayMetadataViewLink

public boolean isDisplayMetadataViewLink()

Returns:

true if metadata view link may be displayed; false otherwise

isDisplayFulltextViewLink

public boolean isDisplayFulltextViewLink()
                                  throws IndexUnreachableException,
DAOException,
PresentationException

Returns:

true if full-text view link may be displayed; false otherwise

Throws:

IndexUnreachableException

DAOException

PresentationException

isDisplayExternalFulltextLink

public boolean isDisplayExternalFulltextLink()

Returns:

true if external full-text link may be displayed; false otherwise

isDisplayNerViewLink

public boolean isDisplayNerViewLink()
                             throws IndexUnreachableException,
PresentationException

Returns:

true if NER view link may be displayed; false otherwise

Throws:

IndexUnreachableException

PresentationException

isDisplayExternalResolverLink

public boolean isDisplayExternalResolverLink()

Returns:

true if NER view link may be displayed; false otherwise

getOaiMarcUrl

public String getOaiMarcUrl()
                     throws IndexUnreachableException

getOaiMarcUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

getOaiDcUrl

public String getOaiDcUrl()
                   throws IndexUnreachableException

getOaiDcUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

getOaiEseUrl

public String getOaiEseUrl()
                    throws IndexUnreachableException

getOaiEseUrl.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

getOpacUrl

public String getOpacUrl()

Getter for the field opacUrl.

Returns:

a String object.

getAnchorTitle

public String getAnchorTitle()

Returns the main title of the current volume's anchor, if available.

Returns:

a String object.

getVolumeTitle

public String getVolumeTitle()

Returns the main title of the current volume.

Returns:

The volume's main title.

isBelowFulltextThreshold

public boolean isBelowFulltextThreshold()
                                 throws PresentationException,
IndexUnreachableException

isBelowFulltextThreshold.

Returns:

a boolean.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getPageCountWithFulltext

public long getPageCountWithFulltext()
                              throws IndexUnreachableException,
PresentationException

Throws:

IndexUnreachableException

PresentationException

isFulltextAvailableForWork

public boolean isFulltextAvailableForWork()
                                   throws IndexUnreachableException,
DAOException,
PresentationException

isFulltextAvailableForWork.

Returns:

true if record has full-text and user has access rights; false otherwise

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

isFulltextFromTEI

public boolean isFulltextFromTEI()
                          throws IndexUnreachableException,
PresentationException

Returns:

true if record full-text is generated from TEI documents; false otherwise

Throws:

PresentationException

IndexUnreachableException

isRecordHasImages

public boolean isRecordHasImages()
                          throws IndexUnreachableException,
DAOException,
RecordNotFoundException

Returns:

true if any of this record's pages has an image and user has access rights; false otherwise

Throws:

IndexUnreachableException

DAOException

RecordNotFoundException

isTeiAvailableForWork

public boolean isTeiAvailableForWork()
                              throws IndexUnreachableException,
DAOException,
PresentationException

isTeiAvailableForWork.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

isRecordHasTEIFiles

public boolean isRecordHasTEIFiles()
                            throws IndexUnreachableException,
PresentationException

Returns:

true if there are any TEI files associated directly with the top document

Throws:

PresentationException

IndexUnreachableException

getToc

public TOC getToc()

Returns:

the toc

setToc

public void setToc(TOC toc)

Parameters:

toc - the toc to set

isAltoAvailableForWork

public boolean isAltoAvailableForWork()
                               throws IndexUnreachableException,
PresentationException,
DAOException

isAltoAvailableForWork.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

getFilenamesByMimeType

public Map<String,List<String>> getFilenamesByMimeType(boolean localFilesOnly)
                                                throws IndexUnreachableException,
PresentationException

Parameters:

localFilesOnly -

Returns:

Map with mime type and file names for each

Throws:

IndexUnreachableException

PresentationException

getMimeTypeViaFileName

public String getMimeTypeViaFileName(String filename)

Parameters:

filename -

Returns:

String

getPageCountWithAlto

public Long getPageCountWithAlto()
                          throws IndexUnreachableException,
PresentationException

Throws:

IndexUnreachableException

PresentationException

getFulltext

@Deprecated(since="24.10")
public String getFulltext()
                   throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Deprecated.

Use PhysicalElement.getFullText()

Default fulltext getter (with HTML escaping).

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getFulltext

@Deprecated(since="24.10")
public String getFulltext(boolean escapeHtml,
 String language)
                   throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Deprecated.

Use PhysicalElement.getFullText()

Returns the full-text for the current page, stripped of any included JavaScript.

Parameters:

escapeHtml - If true HTML tags will be escaped to prevent pseudo-HTML from breaking the text.

language - a String object.

Returns:

Full-text for the current page.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getFulltextMimeType

public String getFulltextMimeType()
                           throws ViewerConfigurationException

Returns:

the probable mimeType of the fulltext of the current page. Loads the fulltext of that page if necessary

Throws:

IndexUnreachableException

DAOException

ViewerConfigurationException

getFulltextMimeType

public String getFulltextMimeType(String language)
                           throws ViewerConfigurationException

Parameters:

language -

Returns:

TEI mime type if TEI files are indexed; mime type from the loaded full-text of the current page otherwise

Throws:

ViewerConfigurationException

getCurrentRotate

public int getCurrentRotate()

getCurrentRotate.

Returns:

a int.

setZoomSlider

public void setZoomSlider(int zoomSlider)

Setter for the field zoomSlider.

Parameters:

zoomSlider - a int.

getZoomSlider

public int getZoomSlider()

Getter for the field zoomSlider.

Returns:

a int.

isDisplayContentDownloadMenu

public boolean isDisplayContentDownloadMenu()

Returns true if original content download has been enabled in the configuration and there are files in the original content folder for this record.

Returns:

a boolean.

getContentDownloadLinksForWork

public List<LabeledLink> getContentDownloadLinksForWork()
                                                 throws IOException,
PresentationException,
IndexUnreachableException,
DAOException

Returns a list of original content file download links (name+url) for the current document.

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

IOException

getLinkToDownloadFile

protected LabeledLink getLinkToDownloadFile(String filename)

getTopStructElementIddoc

public String getTopStructElementIddoc()

Getter for the field topStructElementIddoc.

Returns:

the topStructElementIddoc

getAnchorDocumentIddoc

public String getAnchorDocumentIddoc()

getTopStructElement

public StructElement getTopStructElement()

Getter for the field topStructElement.

Returns:

a StructElement object.

setTopStructElement

public void setTopStructElement(StructElement topStructElement)

setTopStructElement.

Parameters:

topStructElement - the topStructElement to set

getCurrentStructElementIddoc

public String getCurrentStructElementIddoc()

Getter for the field currentStructElementIddoc.

Returns:

the currentStructElementIddoc

setCurrentStructElementtIddoc

public void setCurrentStructElementtIddoc(String currentStructElementIddoc)

Setter for the field currentStructElementIddoc.

Parameters:

currentStructElementIddoc - the currentStructElementIddoc to set

getCurrentStructElement

public StructElement getCurrentStructElement()
                                      throws IndexUnreachableException

Getter for the field currentStructElement.

Returns:

the currentStructElement

Throws:

IndexUnreachableException - if any.

setCurrentStructElement

public void setCurrentStructElement(StructElement currentStructElement)

Setter for the field currentStructElement.

Parameters:

currentStructElement - the currentStructElement to set

getCurrentDocumentHierarchy

public List<StructElementStub> getCurrentDocumentHierarchy()
                                                    throws IndexUnreachableException

getCurrentDocumentHierarchy.

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

getLogId

public String getLogId()

Getter for the field logId.

Returns:

the logId

setLogId

public void setLogId(String logId)

Setter for the field logId.

Parameters:

logId - the logId to set

getPageLoader

public IPageLoader getPageLoader()

Getter for the field pageLoader.

Returns:

the pageLoader

getDublinCoreMetaTags

public String getDublinCoreMetaTags()

Generates DC meta tags for the head of a HTML page.

Returns:

String with tags

getHighwirePressMetaTags

public String getHighwirePressMetaTags()

getHighwirePressMetaTags.

Returns:

String with tags

isHasVersionHistory

public boolean isHasVersionHistory()
                            throws PresentationException,
IndexUnreachableException

isHasVersionHistory.

Returns:

a boolean.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getVersionHistory

public List<String> getVersionHistory()
                               throws PresentationException,
IndexUnreachableException

Getter for the field versionHistory.

Returns:

a List object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getContextObject

public String getContextObject()

Returns the ContextObject value for a COinS element (generated using metadata from currentDocument).

Returns:

a String object.

addToTranskribusAction

public String addToTranskribusAction(boolean login)

addToTranskribusAction.

Parameters:

login - If true, the user will first be logged into their Transkribus account in the UserBean.

Returns:

a String object.

isRecordAddedToTranskribus

public boolean isRecordAddedToTranskribus(TranskribusSession session)
                                   throws DAOException

isRecordAddedToTranskribus.

Parameters:

session - a TranskribusSession object.

Returns:

a boolean.

Throws:

DAOException - if any.

useTiles

public boolean useTiles()
                 throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

useTiles.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

useTilesFullscreen

public boolean useTilesFullscreen()
                           throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

useTilesFullscreen.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getPi

public String getPi()
             throws IndexUnreachableException

Getter for the field pi.

Returns:

the pi

Throws:

IndexUnreachableException - if any.

getAnchorPi

public String getAnchorPi()

If the current record is a volume, returns the PI of the anchor record.

Returns:

anchor PI if record is volume; null otherwise.

getMimeType

public String getMimeType()

Getter for the field mimeType.

Returns:

the mimeType

togglePageOrientation

public void togglePageOrientation()

togglePageOrientation.

setDoublePageMode

public void setDoublePageMode(boolean doublePageMode)

Setter for the field doublePageMode.

Parameters:

doublePageMode - the doublePageMode to set

isDoublePageMode

public boolean isDoublePageMode()

isDoublePageMode.

Returns:

the doublePageMode

isSequenceMode

public boolean isSequenceMode()

getFirstPdfPage

public String getFirstPdfPage()

Getter for the field firstPdfPage.

Returns:

the firstPdfPage

setFirstPdfPage

public void setFirstPdfPage(String firstPdfPage)

Setter for the field firstPdfPage.

Parameters:

firstPdfPage - the firstPdfPage to set

getLastPdfPage

public String getLastPdfPage()

Getter for the field lastPdfPage.

Returns:

the lastPdfPage

setLastPdfPage

public void setLastPdfPage(String lastPdfPage)

Setter for the field lastPdfPage.

Parameters:

lastPdfPage - the lastPdfPage to set

generatePageRangePdf

public void generatePageRangePdf()

getCalendarView

public CalendarView getCalendarView()
                             throws IndexUnreachableException,
PresentationException

Getter for the field calendarView.

Returns:

the calendarView

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getFirstPageOrientation

public PageOrientation getFirstPageOrientation()

Getter for the field firstPageOrientation.

Returns:

the firstPageOrientation

setFirstPageOrientation

public void setFirstPageOrientation(PageOrientation firstPageOrientation)

Setter for the field firstPageOrientation.

Parameters:

firstPageOrientation - the firstPageOrientation to set

getCurrentPageSourceIndex

public int getCurrentPageSourceIndex()
                              throws IndexUnreachableException,
DAOException

getCurrentPageSourceIndex.

Returns:

1 if we are in double page mode and the current page is the right page. 0 otherwise

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getTopDocumentTitle

public String getTopDocumentTitle()

getTopDocumentTitle.

Returns:

a String object.

getDocumentTitle

public String getDocumentTitle(StructElement document)

getDocumentTitle.

Parameters:

document - a StructElement object.

Returns:

a String object.

setPageLoader

public void setPageLoader(IPageLoader loader)

Setter for the field pageLoader.

Parameters:

loader - a IPageLoader object.

getCiteLinkWork

public String getCiteLinkWork()
                       throws IndexUnreachableException,
DAOException,
PresentationException

getCiteLinkWork.

Returns:

A persistent link to the current work

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

isDisplayCiteLinkWork

public boolean isDisplayCiteLinkWork()

isDisplayCiteLinkWork.

Returns:

a boolean.

getCiteLinkDocstruct

public String getCiteLinkDocstruct()
                            throws IndexUnreachableException

Returns:

Citation URL for the current structure element

Throws:

IndexUnreachableException

isDisplayCiteLinkDocstruct

public boolean isDisplayCiteLinkDocstruct()

isDisplayCiteLinkDocstruct.

Returns:

a boolean.

getCiteLinkPage

public String getCiteLinkPage()
                       throws IndexUnreachableException,
DAOException

getCiteLinkPage.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

isDisplayCiteLinkPage

public boolean isDisplayCiteLinkPage()
                              throws IndexUnreachableException,
DAOException

isDisplayCiteLinkPage.

Returns:

a boolean.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getCitationStringHtml

public String getCitationStringHtml()
                             throws IOException,
IndexUnreachableException,
PresentationException

Returns:

HTML-formatted citation text

Throws:

IOException

IndexUnreachableException

PresentationException

getCitationStringPlain

public String getCitationStringPlain()
                              throws IOException,
IndexUnreachableException,
PresentationException

Returns:

Plain citation text

Throws:

IOException

IndexUnreachableException

PresentationException

getCitationStyle

public String getCitationStyle()

Returns:

the citationStyle

setCitationStyle

public void setCitationStyle(String citationStyle)

Parameters:

citationStyle - the citationStyle to set

getCitationProcessorWrapper

public CitationProcessorWrapper getCitationProcessorWrapper()

Returns:

the citationProcessorWrapper

setCitationProcessorWrapper

public void setCitationProcessorWrapper(CitationProcessorWrapper citationProcessorWrapper)

Parameters:

citationProcessorWrapper - the citationProcessorWrapper to set

getSidebarWidgetUsageCitationLinksForLevel

public List<CitationLink> getSidebarWidgetUsageCitationLinksForLevel(String levelName)
                                                              throws PresentationException,
IndexUnreachableException

Parameters:

levelName -

Returns:

List of configured citation links for the given levelName, populated with values

Throws:

IndexUnreachableException

PresentationException

getArchiveEntryIdentifier

public String getArchiveEntryIdentifier()

Returns:

Value of EAD_NODE_ID in the loaded record

createViewManager

public static ViewManager createViewManager(String pi,
 boolean loadPages)
                                     throws PresentationException,
IndexUnreachableException,
DAOException,
RecordNotFoundException

Creates an instance of ViewManager loaded with the record with the given identifier.

Parameters:

pi - Record identifier

loadPages -

Returns:

Created ViewManager

Throws:

PresentationException

IndexUnreachableException

ViewerConfigurationException

DAOException

RecordNotFoundException

getPageRangeAroundPage

public List<Integer> getPageRangeAroundPage(int pageOrder,
 int range,
 boolean fillToSize)
                                     throws IndexUnreachableException

Returns an integer list such that

• the 'pageOrder' is contained in the list
• the list contains (2*range)+1 consecutive numbers, or all page numbers of the current record if it is less than that
• the first number is not less than the first image order
• the last number is not larger than the last image order
• the 'pageOrder' is as far in the middle of the list as possible without violating any of the other points
Used int thumbnailPaginator.xhtml to calculate the pages to display.

Parameters:

pageOrder - The current page number around which to center the numbers

range - The number of numbers to include above and below the current page number, if possible

fillToSize - if true, always return a list of exactly 2*range+1 elements, no matter the total number of pages in the current record

Returns:

an integer list

Throws:

IndexUnreachableException - If the page numbers could not be read from SOLR

IllegalArgumentException - If the pageOrder is not within the range of page numbers of the current record or if range is less than zero

getCopyrightIndicatorStatusName

public String getCopyrightIndicatorStatusName()

Returns:

The most restrictive status name of the configured statuses

getCopyrightIndicatorStatuses

public List<CopyrightIndicatorStatus> getCopyrightIndicatorStatuses()

Returns:

copyrightIndicatorStatuses

getCopyrightIndicatorLicense

public CopyrightIndicatorLicense getCopyrightIndicatorLicense()

Returns:

the copyrightIndicatorLicense

hasPrerenderedPagePdfs

public boolean hasPrerenderedPagePdfs()

getPagesForMediaType

public List<PhysicalElement> getPagesForMediaType(String type)
                                           throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getExternalResourceUrls

public List<String> getExternalResourceUrls()
                                     throws IndexUnreachableException

Throws:

IndexUnreachableException

getAnchorStructElement

public StructElement getAnchorStructElement()

getCssClass

public String getCssClass()
                   throws IndexUnreachableException

Throws:

IndexUnreachableException

isDoublePageNavigationEnabled

public boolean isDoublePageNavigationEnabled(PageType pageType)
                                      throws ViewerConfigurationException

Throws:

ViewerConfigurationException

showImageThumbnailGallery

public boolean showImageThumbnailGallery(PageType pageType)
                                  throws ViewerConfigurationException

Throws:

ViewerConfigurationException