Package io.goobi.viewer.managedbeans

Class ActiveDocumentBean

java.lang.Object

io.goobi.viewer.managedbeans.ActiveDocumentBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class ActiveDocumentBean
extends Object
implements Serializable

JSF session-scoped backing bean that opens the requested record and provides all data relevant to it. Owns the ViewManager for the current record and coordinates access to its structure elements, physical pages, TOC, and download jobs.

Lifecycle: Created once per HTTP session; a new ViewManager is instantiated each time a different record PI is requested. The bean is destroyed when the session expires.

Thread safety: Explicitly synchronised. Multiple synchronized(this) and synchronized(lock) blocks guard concurrent access to shared record state, since JSF AJAX requests and background threads (PDF/EPUB generation, TOC building) may run concurrently within the same session.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	topDocumentIddoc

Constructor Summary

Constructors

Constructor	Description
ActiveDocumentBean()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
protected PageNavigation	calculateCurrentPageNavigation(PageType pageType)
String	calculateSidebarToc()	Recalculates the visibility of TOC elements and jumps to the active element after a +/- button has been pressed.
String	clearCacheAction()	clearCacheAction.
String	deleteRecordAction(boolean keepTraceDocument)	deleteRecordAction.
void	downloadTOCAction()	downloadTOCAction.
GeoMap	generateGeoMap(String pi)	generateGeoMap.
String	getAction()	Getter for the field action.
String	getClearCacheMode()	Getter for the field clearCacheMode.
StructElement	getCurrentElement()	getCurrentElement.
int	getCurrentThumbnailPage()	getCurrentThumbnailPage.
protected PageNavigation	getDefaultPageNavigation(ViewAttributes viewAttributes)
Boolean	getDeleteRecordKeepTrace()	Getter for the field deleteRecordKeepTrace.
String	getFirstPageUrl()	getFirstPageUrl.
String	getFullscreenImageUrl()	getFullscreenImageUrl.
String	getFulltextUrl()	getFulltextUrl.
GeoMap	getGeoMap()	Get a CMSSidebarElement with a map containing all GeoMarkers for the current PI.
List<String>	getGeomapFilters()	getGeomapFilters.
int	getImageContainerWidth()	Getter for the field imageContainerWidth.
String	getImageToShow()	Getter for the field imageToShow.
String	getImageUrl()	getImageUrl.
String	getLabelForJS()	Title bar label value escaped for JavaScript.
String	getLastPageUrl()	getLastPageUrl.
String	getLastReceivedIdentifier()	Getter for the field lastReceivedIdentifier.
String	getLogid()	Getter for the field logid.
String	getMetadataUrl()	getMetadataUrl.
Path	getMetsFilePath()
String	getNextDocstructUrl()	getNextDocstructUrl.
BrowseElement	getNextHit()	Getter for the field nextHit.
String	getNextPageUrl()	getNextPageUrl.
String	getNextPageUrl(int step)	getNextPageUrl.
int	getNumberOfImages()	getNumberOfImages.
String	getPageUrl()	getPageUrl.
String	getPageUrl(int order)	getPageUrl.
String	getPageUrl(String pageOrderRange)	getPageUrl.
String	getPageUrl(String pageType, String pageOrderRange)	Returns the navigation URL for the given page type and number.
String	getPageUrlByType(String pageType)	getPageUrl.
String	getPageUrlRelativeToCurrentPage(int step)	getNextPageUrl.
String	getPdfSize()
String	getPdfSize(String logId)
String	getPersistentIdentifier()	Returns the PI of the currently loaded record.
String	getPIFromFieldValue(String value, String field)	getPIFromFieldValue.
BrowseElement	getPrevHit()	Getter for the field prevHit.
String	getPreviousDocstructUrl()	getPreviousDocstructUrl.
String	getPreviousPageUrl()	getPreviousPageUrl.
String	getPreviousPageUrl(int step)	getPreviousPageUrl.
RecordGeoMap	getRecordGeoMap()	getRecordGeoMap.
List<String>	getRecordLanguages()	Getter for the field recordLanguages.
List<SearchHit>	getRelatedItems(String identifierField)	getRelatedItems.
String	getRelatedItemsQueryString(String identifierField)	Returns a query string containing all values of the given identifier field.
String	getRelativeUrlTags()	Returns a string that contains previous and/or next url elements.
DownloadOption	getSelectedDownloadOption()	getSelectedDownloadOption.
String	getSelectedDownloadOptionLabel()	Getter for the field selectedDownloadOptionLabel.
DownloadOption	getSelectedDownloadOptionOrDefault()
String	getSelectedRecordLanguage()	Getter for the field selectedRecordLanguage.
String	getSelectedRecordLanguage3()	Getter for the field selectedRecordLanguage.
String	getTitleBarLabel()	getTitleBarLabel.
String	getTitleBarLabel(String language)	getTitleBarLabel.
String	getTitleBarLabel(Locale locale)	getTitleBarLabel.
TOC	getToc()	Getter for the field toc.
String	getTocCurrentPage()	Getter for the field tocCurrentPage.
StructElement	getTopDocument()	getTopDocument.
String	getTopDocumentIddoc()	Getter for the field topDocumentIddoc.
ViewManager	getViewManager()	Do not call from ActiveDocumentBean.update()!
boolean	hasAnchor()	Checks if there is an anchor in this docStruct's hierarchy.
boolean	isAccessPermissionEpub()	isAccessPermissionEpub.
boolean	isAccessPermissionPdf()	isAccessPermissionPdf.
boolean	isAllowUserComments()	Indicates whether user comments are allowed for the current record based on several criteria.
boolean	isAnchor()	isAnchor.
boolean	isDownloadImageModalVisible()	isDownloadImageModalVisible.
boolean	isGroup()	isGroup.
boolean	isHasLanguages()	isHasLanguages.
boolean	isRecordLoaded()	Indicates whether a record is currently properly loaded in this bean.
boolean	isRequiresWebSocket()	Checks if the current page should initialize a WebSocket.
boolean	isVolume()	isVolume.
String	open()	Pretty-URL entry point.
String	openFulltext()	openFulltext.
String	reIndexRecordAction()	Exports the currently loaded for re-indexing.
String	reload(String pi)	reload.
void	reset()	Resets the bean state when a record is unloaded: discards the current ViewManager, clears navigation state (logid, action, prev/next hit, docstruct URL caches), and notifies all registered modules.
void	resetAccess()	resets the access rights for user comments and pdf download stored in ViewManager.
void	setAction(String action)	Setter for the field action.
void	setAnchor(boolean anchor)	Setter for the field anchor.
void	setBookshelfBean(BookmarkBean bookshelfBean)	Required setter for ManagedProperty injection.
void	setBreadcrumbBean(BreadcrumbBean breadcrumbBean)	Required setter for ManagedProperty injection.
void	setChildrenInvisible(TOCElement element)	setChildrenInvisible.
void	setChildrenVisible(TOCElement element)	setChildrenVisible.
void	setClearCacheMode(String clearCacheMode)	Setter for the field clearCacheMode.
void	setCmsBean(CmsBean cmsBean)	Required setter for ManagedProperty injection.
void	setCurrentImageOrderPerScript()
void	setCurrentThumbnailPage(int currentThumbnailPage)	setCurrentThumbnailPage.
void	setDeleteRecordKeepTrace(Boolean deleteRecordKeepTrace)	Setter for the field deleteRecordKeepTrace.
String	setDoublePageModeAction(boolean doublePageMode)	Augments the setter ViewManager.setDoublePageMode(boolean) with URL modifications to reflect the mode.
void	setDownloadOptionLabelFromRequestParameter()	setDownloadOptionLabelFromRequestParameter.
void	setImageToShow(String imageToShow)	Setter for the field imageToShow.
void	setLastReceivedIdentifier(String lastReceivedIdentifier)	Setter for the field lastReceivedIdentifier.
void	setLogid(String logid)	Setter for the field logid.
void	setNavigationHelper(NavigationHelper navigationHelper)	Required setter for ManagedProperty injection.
void	setPersistentIdentifier(String persistentIdentifier)	setPersistentIdentifier.
void	setRecordLanguages(List<String> recordLanguages)	Setter for the field recordLanguages.
void	setRepresentativeImage()	Sets imageToShow to the representative page found in the search index, or "1" if none found.
void	setSearchBean(SearchBean searchBean)	Required setter for ManagedProperty injection.
void	setSelectedDownloadOptionLabel(String selectedDownloadOptionLabel)	Setter for the field selectedDownloadOptionLabel.
void	setSelectedRecordLanguage(String selectedRecordLanguageCode)	Setter for the field selectedRecordLanguage.
void	setSelectedRecordLanguage3(String selectedRecordLanguageCode)	Setter to match getSelectedRecordLanguage3() for URL patterns.
void	setTocCurrentPage(String tocCurrentPage)	Setter for the field tocCurrentPage.
void	toggleDownloadImageModal()	toggleDownloadImageModal.
void	update()	Loads the record with the IDDOC set in currentElementIddoc.
void	updatePageNavigation(PageType pageType)

Methods inherited from class java.lang.Object

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

Field Details

topDocumentIddoc

protected String topDocumentIddoc

Constructor Details

ActiveDocumentBean

public ActiveDocumentBean()

Empty constructor.

Method Details

setNavigationHelper

public void setNavigationHelper(NavigationHelper navigationHelper)

Required setter for ManagedProperty injection.

Parameters:

navigationHelper - the NavigationHelper instance to inject for testing

setCmsBean

public void setCmsBean(CmsBean cmsBean)

Required setter for ManagedProperty injection.

Parameters:

cmsBean - the CmsBean instance to inject for testing

setSearchBean

public void setSearchBean(SearchBean searchBean)

Required setter for ManagedProperty injection.

Parameters:

searchBean - the SearchBean instance to inject for testing

setBookshelfBean

public void setBookshelfBean(BookmarkBean bookshelfBean)

Required setter for ManagedProperty injection.

Parameters:

bookshelfBean - the BookmarkBean instance to inject for testing

setBreadcrumbBean

public void setBreadcrumbBean(BreadcrumbBean breadcrumbBean)

Required setter for ManagedProperty injection.

Parameters:

breadcrumbBean - the BreadcrumbBean instance to inject for testing

reset

public void reset()
           throws IndexUnreachableException

Resets the bean state when a record is unloaded: discards the current ViewManager, clears navigation state (logid, action, prev/next hit, docstruct URL caches), and notifies all registered modules.

Warning: Although this method is fully synchronized(this), calling it while update() is running on another thread may still cause NPEs, because update() holds the lock only in discrete blocks and not for its entire duration.

Throws:

IndexUnreachableException - if a module's cleanup requires Solr and Solr is unavailable

getViewManager

public ViewManager getViewManager()

Do not call from ActiveDocumentBean.update()!

Returns:

the current ViewManager, triggering an update if not yet initialized

reload

public String reload(String pi)
              throws PresentationException,
RecordNotFoundException,
RecordDeletedException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException,
RecordLimitExceededException

reload.

Parameters:

pi - persistent identifier of the record to reload

Returns:

output of open()

Throws:

PresentationException

RecordNotFoundException

RecordDeletedException

IndexUnreachableException

DAOException

ViewerConfigurationException

RecordLimitExceededException

update

public void update()
            throws PresentationException,
IndexUnreachableException,
RecordNotFoundException,
RecordDeletedException,
DAOException,
ViewerConfigurationException,
IDDOCNotFoundException,
NumberFormatException,
RecordLimitExceededException

Loads the record with the IDDOC set in currentElementIddoc.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

RecordNotFoundException - if any.

RecordDeletedException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

IDDOCNotFoundException

RecordLimitExceededException

NumberFormatException

open

public String open()
            throws RecordNotFoundException,
RecordDeletedException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException,
RecordLimitExceededException

Pretty-URL entry point.

Returns:

an empty string after initializing the record view for the current URL

Throws:

RecordNotFoundException - if any.

RecordDeletedException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

RecordLimitExceededException

openFulltext

public String openFulltext()
                    throws RecordNotFoundException,
RecordDeletedException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException,
NumberFormatException,
RecordLimitExceededException

openFulltext.

Returns:

the view name for the fulltext view after opening the record

Throws:

RecordNotFoundException - if any.

RecordDeletedException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

RecordLimitExceededException

NumberFormatException

getPrevHit

public BrowseElement getPrevHit()
                         throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Getter for the field prevHit.

Returns:

the previous search hit browse element, or null if there is none

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getNextHit

public BrowseElement getNextHit()
                         throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Getter for the field nextHit.

Returns:

the next search hit browse element, or null if there is none

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCurrentElement

public StructElement getCurrentElement()
                                throws IndexUnreachableException

getCurrentElement.

Returns:

the StructElement for the currently displayed structural unit, or null if no record is loaded

Throws:

IndexUnreachableException - if any.

setCurrentImageOrderPerScript

public void setCurrentImageOrderPerScript()
                                   throws NumberFormatException,
IndexUnreachableException,
PresentationException,
IDDOCNotFoundException,
RecordNotFoundException,
RecordDeletedException,
DAOException,
ViewerConfigurationException,
RecordLimitExceededException,
IllegalUrlParameterException

Throws:

NumberFormatException

IndexUnreachableException

PresentationException

IDDOCNotFoundException

RecordNotFoundException

RecordDeletedException

DAOException

ViewerConfigurationException

RecordLimitExceededException

IllegalUrlParameterException

setImageToShow

public void setImageToShow(String imageToShow)
                    throws IllegalUrlParameterException

Setter for the field imageToShow.

Parameters:

imageToShow - Single page number (1) or range (2-3)

Throws:

IllegalUrlParameterException

setRepresentativeImage

public void setRepresentativeImage()
                            throws PresentationException,
IndexUnreachableException,
ViewerConfigurationException,
IllegalUrlParameterException

Sets imageToShow to the representative page found in the search index, or "1" if none found.

Throws:

PresentationException

IndexUnreachableException

ViewerConfigurationException

IllegalUrlParameterException

getImageToShow

public String getImageToShow()

Getter for the field imageToShow.

Returns:

single page number (e.g. "1") or range (e.g. "2-3") of the image(s) currently displayed

setLogid

public void setLogid(String logid)
              throws IllegalUrlParameterException

Setter for the field logid.

Parameters:

logid - structural element LOGID to navigate to, or "-" / empty for the top-level document

Throws:

PresentationException

IllegalUrlParameterException

getLogid

public String getLogid()

Getter for the field logid.

Returns:

the LOGID of the current structural element, or "-" if at top-level document

isAnchor

public boolean isAnchor()

isAnchor.

Returns:

true if the current record is an anchor document (e.g. a multi-volume work); false otherwise

setAnchor

public void setAnchor(boolean anchor)

Setter for the field anchor.

Parameters:

anchor - true if the current record is an anchor document

isVolume

public boolean isVolume()

isVolume.

Returns:

true if the current record is a volume (child of a multi-volume work), false otherwise

isGroup

public boolean isGroup()

isGroup.

Returns:

true if the current record is a group document, false otherwise

getAction

public String getAction()

Getter for the field action.

Returns:

the navigation action string (e.g. "nextHit", "prevHit"), or null if none set

setAction

public void setAction(String action)

Setter for the field action.

Parameters:

action - navigation action string (e.g. "nextHit", "prevHit") to execute

getPIFromFieldValue

public String getPIFromFieldValue(String value,
 String field)
                           throws PresentationException,
IndexUnreachableException

getPIFromFieldValue.

Parameters:

value - field value to search for

field - Solr field name to query

Returns:

the persistent identifier of the first record matching the field/value query, or empty string if none found

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

setPersistentIdentifier

public void setPersistentIdentifier(String persistentIdentifier)
                             throws PresentationException,
RecordNotFoundException,
IndexUnreachableException

setPersistentIdentifier.

Parameters:

persistentIdentifier - persistent identifier of the record to load

Throws:

PresentationException - if any.

RecordNotFoundException - if any.

IndexUnreachableException - if any.

getPersistentIdentifier

public String getPersistentIdentifier()
                               throws IndexUnreachableException

Returns the PI of the currently loaded record. Only call this method after the update() method has re-initialized ViewManager, otherwise the previous PI may be returned!

Returns:

the persistent identifier of the currently loaded record, or "-" if no record is loaded

Throws:

IndexUnreachableException - if any.

getPageUrl

public String getPageUrl(String pageType,
 String pageOrderRange)
                  throws IndexUnreachableException

Returns the navigation URL for the given page type and number.

Parameters:

pageType - view page type name, e.g. "viewObject"

pageOrderRange - Single page number or range

Returns:

the absolute URL to the specified page type and order for the current record

Throws:

IndexUnreachableException - if any.

getPageUrl

public String getPageUrl(String pageOrderRange)
                  throws IndexUnreachableException

getPageUrl.

Parameters:

pageOrderRange - Single page number or range

Returns:

the absolute URL to the current view page type for the given page order range

Throws:

IndexUnreachableException - if any.

getPageUrl

public String getPageUrl()
                  throws IndexUnreachableException

getPageUrl.

Returns:

the absolute URL to the current page in the preferred or currently active view

Throws:

IndexUnreachableException - if any.

getPageUrlByType

public String getPageUrlByType(String pageType)
                        throws IndexUnreachableException

getPageUrl.

Parameters:

pageType - view page type name, e.g. "viewObject"

Returns:

the absolute URL for the given view page type of the currently loaded record

Throws:

IndexUnreachableException - if any.

getFirstPageUrl

public String getFirstPageUrl()
                       throws IndexUnreachableException

getFirstPageUrl.

Returns:

the absolute URL to the first page of the current record, or null if no record is loaded

Throws:

IndexUnreachableException - if any.

getLastPageUrl

public String getLastPageUrl()
                      throws IndexUnreachableException

getLastPageUrl.

Returns:

the absolute URL to the last page of the current record, or null if no record is loaded

Throws:

IndexUnreachableException - if any.

getPageUrlRelativeToCurrentPage

public String getPageUrlRelativeToCurrentPage(int step)
                                       throws IndexUnreachableException

getNextPageUrl.

Parameters:

step - number of pages to advance (positive or negative)

Returns:

the absolute URL to the page that is the given number of steps from the current page

Throws:

IndexUnreachableException - if any.

getPageUrl

public String getPageUrl(int order)
                  throws IndexUnreachableException

getPageUrl.

Parameters:

order - physical page order number

Returns:

Page URL for the given page number

Throws:

IndexUnreachableException

getPreviousPageUrl

public String getPreviousPageUrl(int step)
                          throws IndexUnreachableException

getPreviousPageUrl.

Parameters:

step - number of pages to go back

Returns:

the absolute URL to the page that is the given number of steps before the current page

Throws:

IndexUnreachableException - if any.

getNextPageUrl

public String getNextPageUrl(int step)
                      throws IndexUnreachableException

getNextPageUrl.

Parameters:

step - number of pages to advance forward

Returns:

the absolute URL to the page that is the given number of steps after the current page

Throws:

IndexUnreachableException - if any.

getPreviousPageUrl

public String getPreviousPageUrl()
                          throws IndexUnreachableException

getPreviousPageUrl.

Returns:

the absolute URL to the page one step before the current page

Throws:

IndexUnreachableException - if any.

getNextPageUrl

public String getNextPageUrl()
                      throws IndexUnreachableException

getNextPageUrl.

Returns:

the absolute URL to the page one step after the current page

Throws:

IndexUnreachableException - if any.

getPreviousDocstructUrl

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

getPreviousDocstructUrl.

Returns:

URL to the previous docstruct

Throws:

IndexUnreachableException

ViewerConfigurationException

DAOException

PresentationException

getNextDocstructUrl

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

getNextDocstructUrl.

Returns:

URL to the next docstruct

Throws:

IndexUnreachableException

ViewerConfigurationException

DAOException

PresentationException

getImageUrl

public String getImageUrl()
                   throws IndexUnreachableException

getImageUrl.

Returns:

the absolute URL to the image view for the current page

Throws:

IndexUnreachableException - if any.

getFullscreenImageUrl

public String getFullscreenImageUrl()
                             throws IndexUnreachableException

getFullscreenImageUrl.

Returns:

the absolute URL to the fullscreen image view for the current page

Throws:

IndexUnreachableException - if any.

getFulltextUrl

public String getFulltextUrl()
                      throws IndexUnreachableException

getFulltextUrl.

Returns:

the absolute URL to the fulltext view for the current page

Throws:

IndexUnreachableException - if any.

getMetadataUrl

public String getMetadataUrl()
                      throws IndexUnreachableException

getMetadataUrl.

Returns:

the absolute URL to the metadata view for the current page

Throws:

IndexUnreachableException - if any.

getTopDocument

public StructElement getTopDocument()

getTopDocument.

Returns:

the top-level StructElement of the current record, or null if no record is loaded

setChildrenVisible

public void setChildrenVisible(TOCElement element)
                        throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

setChildrenVisible.

Parameters:

element - TOC element whose children to make visible

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

setChildrenInvisible

public void setChildrenInvisible(TOCElement element)
                          throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

setChildrenInvisible.

Parameters:

element - TOC element whose children to hide

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

calculateSidebarToc

public String calculateSidebarToc()
                           throws IOException,
PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Recalculates the visibility of TOC elements and jumps to the active element after a +/- button has been pressed.

Returns:

the anchor fragment URL of the active TOC element, or null if none is active

Throws:

IOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getToc

public TOC getToc()
           throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Getter for the field toc.

Returns:

the TOC for the currently loaded record, or null if no record is loaded

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getTocCurrentPage

public String getTocCurrentPage()

Getter for the field tocCurrentPage.

Returns:

a int.

setTocCurrentPage

public void setTocCurrentPage(String tocCurrentPage)
                       throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException,
IllegalUrlParameterException

Setter for the field tocCurrentPage.

Parameters:

tocCurrentPage - desired TOC pagination page number

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

IllegalUrlParameterException - if tocCurrentPage is not a valid integer or range

getTitleBarLabel

public String getTitleBarLabel(Locale locale)
                        throws IndexUnreachableException,
PresentationException,
DAOException,
ViewerConfigurationException

getTitleBarLabel.

Parameters:

locale - locale used to select the label language

Returns:

the title bar label for the current page in the given locale

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getTitleBarLabel

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

getTitleBarLabel.

Returns:

the title bar label for the current page in the active user locale

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getTitleBarLabel

public String getTitleBarLabel(String language)
                        throws IndexUnreachableException,
PresentationException,
DAOException,
ViewerConfigurationException

getTitleBarLabel.

Parameters:

language - ISO 639 language code for label selection

Returns:

the title bar label for the current page in the given language, or null if no label could be determined

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getLabelForJS

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

Title bar label value escaped for JavaScript.

Returns:

the title bar label with JavaScript special characters escaped, or null if no label is available

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getPdfSize

public String getPdfSize()

getPdfSize

public String getPdfSize(String logId)

getMetsFilePath

public Path getMetsFilePath()
                     throws IndexUnreachableException

Throws:

IndexUnreachableException

getImageContainerWidth

public int getImageContainerWidth()

Getter for the field imageContainerWidth.

Returns:

a int.

getNumberOfImages

public int getNumberOfImages()
                      throws IndexUnreachableException

getNumberOfImages.

Returns:

a int.

Throws:

IndexUnreachableException - if any.

getTopDocumentIddoc

public String getTopDocumentIddoc()

Getter for the field topDocumentIddoc.

Returns:

Not this.topDocumentIddoc but ViewManager.topDocumentIddoc

isRecordLoaded

public boolean isRecordLoaded()

Indicates whether a record is currently properly loaded in this bean. Use to determine whether to display components.

Returns:

true if a record is currently loaded in this bean, false otherwise

hasAnchor

public boolean hasAnchor()
                  throws IndexUnreachableException

Checks if there is an anchor in this docStruct's hierarchy.

Returns:

true if the current record has an anchor (i.e. is a child of a multi-volume work), false otherwise

Throws:

IndexUnreachableException - if any.

reIndexRecordAction

public String reIndexRecordAction()
                           throws IndexUnreachableException,
DAOException,
RecordNotFoundException

Exports the currently loaded for re-indexing.

Returns:

an empty string after triggering the re-indexing of the current record

Throws:

IndexUnreachableException - if any.

DAOException - if any.

RecordNotFoundException - if any.

deleteRecordAction

public String deleteRecordAction(boolean keepTraceDocument)
                          throws IOException,
IndexUnreachableException

deleteRecordAction.

Parameters:

keepTraceDocument - If true, a .delete file will be created; otherwise a .purge file

Returns:

outcome

Throws:

IOException - if any.

IndexUnreachableException - if any.

clearCacheAction

public String clearCacheAction()
                        throws IOException,
IndexUnreachableException

clearCacheAction.

Returns:

empty string

Throws:

IOException

IndexUnreachableException

getCurrentThumbnailPage

public int getCurrentThumbnailPage()

getCurrentThumbnailPage.

Returns:

a int.

setCurrentThumbnailPage

public void setCurrentThumbnailPage(int currentThumbnailPage)

setCurrentThumbnailPage.

Parameters:

currentThumbnailPage - thumbnail grid page number to set

isHasLanguages

public boolean isHasLanguages()

isHasLanguages.

Returns:

true if the current record is available in multiple languages, false otherwise

getLastReceivedIdentifier

public String getLastReceivedIdentifier()

Getter for the field lastReceivedIdentifier.

Returns:

the persistent identifier of the last successfully loaded record

setLastReceivedIdentifier

public void setLastReceivedIdentifier(String lastReceivedIdentifier)

Setter for the field lastReceivedIdentifier.

Parameters:

lastReceivedIdentifier - the persistent identifier of the last successfully loaded record

getRecordLanguages

public List<String> getRecordLanguages()

Getter for the field recordLanguages.

Returns:

list of ISO 639-1 language codes available for the current record

setRecordLanguages

public void setRecordLanguages(List<String> recordLanguages)

Setter for the field recordLanguages.

Parameters:

recordLanguages - list of ISO 639-1 language codes available for the current record

getSelectedRecordLanguage

public String getSelectedRecordLanguage()

Getter for the field selectedRecordLanguage.

Returns:

the 639_1 code for selectedRecordLanguage

setSelectedRecordLanguage

public void setSelectedRecordLanguage(String selectedRecordLanguageCode)

Setter for the field selectedRecordLanguage.

Parameters:

selectedRecordLanguageCode - ISO 639-1 language code of the language to select for this record

getSelectedRecordLanguage3

public String getSelectedRecordLanguage3()

Getter for the field selectedRecordLanguage.

Returns:

the 639_2B code for selectedRecordLanguage

setSelectedRecordLanguage3

public void setSelectedRecordLanguage3(String selectedRecordLanguageCode)

Setter to match getSelectedRecordLanguage3() for URL patterns.

Parameters:

selectedRecordLanguageCode - ISO 639-2/B language code to set

isAccessPermissionEpub

public boolean isAccessPermissionEpub()

isAccessPermissionEpub.

Returns:

true if the current user has permission to download an EPUB of the current record, false otherwise

isAccessPermissionPdf

public boolean isAccessPermissionPdf()

isAccessPermissionPdf.

Returns:

true if the current user has permission to download a PDF of the current record, false otherwise

downloadTOCAction

public void downloadTOCAction()
                       throws IOException,
PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

downloadTOCAction.

Throws:

IOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getRelatedItems

public List<SearchHit> getRelatedItems(String identifierField)
                                throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

getRelatedItems.

TODO Is this still in use?

Parameters:

identifierField - Index field containing related item identifiers

Returns:

List of related items as SearchHit objects.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getRelatedItemsQueryString

public String getRelatedItemsQueryString(String identifierField)

Returns a query string containing all values of the given identifier field.

Parameters:

identifierField - Index field containing related item identifiers

Returns:

Query string of the pattern "PI:(a OR b OR c)"

getRelativeUrlTags

public String getRelativeUrlTags()
                          throws IndexUnreachableException,
DAOException,
PresentationException

Returns a string that contains previous and/or next url elements.

Returns:

string containing previous and/or next url elements

Throws:

IndexUnreachableException - if any.

DAOException - if any.

PresentationException - if any.

resetAccess

public void resetAccess()

resets the access rights for user comments and pdf download stored in ViewManager. After reset, the access rights will be evaluated again on being called

getDeleteRecordKeepTrace

public Boolean getDeleteRecordKeepTrace()

Getter for the field deleteRecordKeepTrace.

Returns:

true to keep a deletion trace entry when deleting the record; false to remove completely; null if not yet set

setDeleteRecordKeepTrace

public void setDeleteRecordKeepTrace(Boolean deleteRecordKeepTrace)

Setter for the field deleteRecordKeepTrace.

Parameters:

deleteRecordKeepTrace - true to keep a deletion trace entry when deleting the record; false to remove completely

getClearCacheMode

public String getClearCacheMode()

Getter for the field clearCacheMode.

Returns:

cache clearing mode string indicating which caches to clear, or null if not set

setClearCacheMode

public void setClearCacheMode(String clearCacheMode)

Setter for the field clearCacheMode.

Parameters:

clearCacheMode - cache clearing mode string indicating which caches to clear

getGeoMap

public GeoMap getGeoMap()
                 throws DAOException,
IndexUnreachableException

Get a CMSSidebarElement with a map containing all GeoMarkers for the current PI. The widget is stored in the bean, but refreshed each time the PI changes

Returns:

GeoMap

Throws:

DAOException

IndexUnreachableException

getRecordGeoMap

public RecordGeoMap getRecordGeoMap()
                             throws DAOException,
IndexUnreachableException

getRecordGeoMap.

Returns:

RecordGeoMap

Throws:

DAOException

IndexUnreachableException

generateGeoMap

public GeoMap generateGeoMap(String pi)
                      throws PresentationException,
DAOException

generateGeoMap.

Parameters:

pi - persistent identifier of the record to map

Returns:

GeoMap

Throws:

PresentationException

DAOException

toggleDownloadImageModal

public void toggleDownloadImageModal()

toggleDownloadImageModal.

isDownloadImageModalVisible

public boolean isDownloadImageModalVisible()

isDownloadImageModalVisible.

Returns:

true if the download image modal dialog is currently visible; false otherwise

getSelectedDownloadOption

public DownloadOption getSelectedDownloadOption()

getSelectedDownloadOption.

Returns:

Selected DownloadOption

getSelectedDownloadOptionOrDefault

public DownloadOption getSelectedDownloadOptionOrDefault()
                                                  throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Throws:

IndexUnreachableException

DAOException

ViewerConfigurationException

getSelectedDownloadOptionLabel

public String getSelectedDownloadOptionLabel()

Getter for the field selectedDownloadOptionLabel.

Returns:

the label of the download option currently selected by the user, or null if none selected

setSelectedDownloadOptionLabel

public void setSelectedDownloadOptionLabel(String selectedDownloadOptionLabel)

Setter for the field selectedDownloadOptionLabel.

Parameters:

selectedDownloadOptionLabel - label of the download option selected by the user

setDownloadOptionLabelFromRequestParameter

public void setDownloadOptionLabelFromRequestParameter()

setDownloadOptionLabelFromRequestParameter.

setDoublePageModeAction

public String setDoublePageModeAction(boolean doublePageMode)

Augments the setter ViewManager.setDoublePageMode(boolean) with URL modifications to reflect the mode.

Parameters:

doublePageMode - The doublePageMode to set

Returns:

empty string

isAllowUserComments

public boolean isAllowUserComments()
                            throws DAOException

Indicates whether user comments are allowed for the current record based on several criteria.

Returns:

true if user comments are allowed for the current record, false otherwise

Throws:

DAOException

isRequiresWebSocket

public boolean isRequiresWebSocket()

Checks if the current page should initialize a WebSocket.

Returns:

true if a document is loaded and it contains the field SolrConstants.ACCESSCONDITION_CONCURRENTUSE

getGeomapFilters

public List<String> getGeomapFilters()

getGeomapFilters.

Returns:

a list of Solr field names used as geo map filter options, formatted as quoted strings

updatePageNavigation

public void updatePageNavigation(PageType pageType)

calculateCurrentPageNavigation

protected PageNavigation calculateCurrentPageNavigation(PageType pageType)

getDefaultPageNavigation

protected PageNavigation getDefaultPageNavigation(ViewAttributes viewAttributes)