Package io.goobi.viewer.dao.impl

Class JPADAO

java.lang.Object

io.goobi.viewer.dao.impl.JPADAO

All Implemented Interfaces:

IDAO

public class JPADAO
extends Object
implements IDAO

JPA-based implementation of IDAO, providing all database access operations for the viewer.

Constructor Summary

Constructors

Constructor	Description
JPADAO()	Creates a new JPADAO instance.
JPADAO(String inPersistenceUnitName)	Creates a new JPADAO instance.

Method Summary

Modifier and Type	Method	Description
boolean	addAnnotation(CrowdsourcingAnnotation annotation)	addAnnotation.
boolean	addBookmarkList(BookmarkList bookmarkList)	addBookmarkList.
boolean	addCampaign(Campaign campaign)	addCampaign.
boolean	addCategory(CMSCategory category)	addCategory.
boolean	addCMSCollection(CMSCollection collection)	addCMSCollection.
boolean	addCMSComponent(PersistentCMSComponent persistentCMSComponent)
boolean	addCMSMediaItem(CMSMediaItem item)	addCMSMediaItem.
boolean	addCMSNavigationItem(CMSNavigationItem item)	addCMSNavigationItem.
boolean	addCMSPage(CMSPage page)	addCMSPage.
boolean	addCMSPageTemplate(CMSPageTemplate template)
boolean	addComment(Comment comment)	addComment.
boolean	addCommentGroup(CommentGroup commentGroup)	addCommentGroup.
boolean	addCustomWidget(CustomSidebarWidget widget)
boolean	addGeoMap(GeoMap map)	Adds the given map to the database if no map of the same id already exists.
boolean	addHighlight(HighlightData object)
boolean	addIpRange(IpRange ipRange)	addIpRange.
boolean	addLicense(License license)	addLicenseType.
boolean	addLicenseType(LicenseType licenseType)	addLicenseType.
boolean	addRecordNote(CMSRecordNote note)	Persist a new CMSRecordNote.
boolean	addRecurringTaskTrigger(RecurringTaskTrigger trigger)
boolean	addRole(Role role)	addRole.
boolean	addSearch(Search search)	addSearch.
boolean	addSlider(CMSSlider slider)
boolean	addStaticPage(CMSStaticPage page)	addStaticPage.
boolean	addTheme(ThemeConfiguration theme)
boolean	addTicket(AccessTicket ticket)	addTicket.
boolean	addTranskribusJob(TranskribusJob job)	addTranskribusJob.
boolean	addUploadJob(UploadJob uploadJob)	addDownloadJob.
boolean	addUsageStatistics(DailySessionUsageStatistics statistics)
boolean	addUser(User user)	addUser.
boolean	addUserGroup(UserGroup userGroup)	addUserGroup.
boolean	addUserRole(UserRole userRole)	addUserRole.
boolean	addViewerMessage(ViewerMessage message)
int	changeCampaignStatisticContributors(User fromUser, User toUser)	Replaced fromUser with toUser in the lists of annotators and reviewers an all campaign statistics.
int	changeCommentsOwner(User fromUser, User toUser)	Changes ownership of all comments from fromUser to toUser.
boolean	checkAvailability()
void	clear()	Currently noop since no persistence entity manager is kept.
void	close(EntityManager em)	Operation to call after a query or other kind of transaction is complete.
boolean	columnsExists(String tableName, String columnName)	columnsExists.
void	commitTransaction(EntityManager em)	Call EntityTransaction.commit() on the current transaction of the given EntityManager.
void	commitTransaction(EntityTransaction et)	Commits a persistence context transaction.
long	countCommentsForWork(String pi)	countCommentsForWork.
static String	createCMSPageFilter(Map<String,Object> params, String pageParameter, List<Long> allowedTemplates, List<String> allowedSubthemes, List<String> allowedCategoryIds)	createCMSPageFilter.
boolean	deleteAnnotation(CrowdsourcingAnnotation annotation)	deleteAnnotation.
boolean	deleteBookmarkList(BookmarkList bookmarkList)	deleteBookmarkList.
boolean	deleteCampaign(Campaign campaign)	deleteCampaign.
int	deleteCampaignStatisticsForUser(User user)	Deletes given user from the lists of annotators and reviewers an all campaign statistics.
boolean	deleteCategory(CMSCategory category)	deleteCategory.
boolean	deleteClientApplication(long id)
boolean	deleteCMSArchiveConfig(CMSArchiveConfig config)	deleteCMSArchiveConfig.
boolean	deleteCMSCollection(CMSCollection collection)	deleteCMSCollection.
boolean	deleteCMSComponent(PersistentCMSComponent component)
boolean	deleteCMSContent(CMSContent content)
boolean	deleteCMSMediaItem(CMSMediaItem item)	deleteCMSMediaItem.
boolean	deleteCMSNavigationItem(CMSNavigationItem item)	deleteCMSNavigationItem.
boolean	deleteCMSPage(CMSPage page)	deleteCMSPage.
boolean	deleteComment(Comment comment)	deleteComment.
boolean	deleteCommentGroup(CommentGroup commentGroup)	deleteCommentGroup.
int	deleteComments(String pi, User owner)
boolean	deleteCustomWidget(Long id)
boolean	deleteGeoMap(GeoMap map)	Deletes the given GeoMap from the database.
boolean	deleteHighlight(Long id)
boolean	deleteIpRange(IpRange ipRange)	deleteIpRange.
boolean	deleteLicense(License license)	deleteLicenseType.
boolean	deleteLicenseType(LicenseType licenseType)	deleteLicenseType.
boolean	deleteRecordNote(CMSRecordNote note)	Deletes an existing CMSRecordNote.
boolean	deleteRecurringTaskTrigger(Long id)
boolean	deleteRole(Role role)	deleteRole.
boolean	deleteSearch(Search search)	deleteSearch.
boolean	deleteSlider(CMSSlider slider)
boolean	deleteStaticPage(CMSStaticPage page)	deleteStaticPage.
boolean	deleteTheme(ThemeConfiguration theme)
boolean	deleteTicket(AccessTicket ticket)	deleteTicket.
boolean	deleteTranskribusJob(TranskribusJob job)	deleteTranskribusJob.
boolean	deleteUploadJob(UploadJob uploadJob)	deleteDownloadJob.
boolean	deleteUsageStatistics(long id)
boolean	deleteUser(User user)	deleteUser.
boolean	deleteUserGroup(UserGroup userGroup)	deleteUserGroup.
boolean	deleteUserRole(UserRole userRole)	deleteUserRole.
boolean	deleteViewerMessage(ViewerMessage message)
int	deleteViewerMessagesBefore(LocalDateTime date)
int	executeUpdate(String query)
long	getActiveTicketCount(Map<String,String> filters)	getActiveTicketCount.
List<AccessTicket>	getActiveTickets(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getActiveRecordAccessTickets.
List<User>	getAdminUsers()
List<CrowdsourcingAnnotation>	getAllAnnotations(String sortField, boolean descending)
List<CrowdsourcingAnnotation>	getAllAnnotationsByMotivation(String motivation)
List<BookmarkList>	getAllBookmarkLists()	getAllBookmarkLists.
List<Campaign>	getAllCampaigns()	getAllCampaigns.
List<CMSCategory>	getAllCategories()	getAllCategories.
List<ClientApplication>	getAllClientApplications()
List<CMSMediaItem>	getAllCMSCollectionItems()	getAllCMSCollectionItems.
List<CMSMediaItem>	getAllCMSMediaItems()	getAllCMSMediaItems.
List<CMSPage>	getAllCMSPages()	getAllCMSPages.
List<CMSPageTemplate>	getAllCMSPageTemplates()
List<CommentGroup>	getAllCommentGroups()
List<Comment>	getAllComments()	getAllComments.
List<CustomSidebarWidget>	getAllCustomWidgets()
List<GeoMap>	getAllGeoMaps()	Gets all GeoMaps in database.
List<HighlightData>	getAllHighlights()
List<IpRange>	getAllIpRanges()	getAllIpRanges.
List<License>	getAllLicenses()	getAllLicenses.
List<LicenseType>	getAllLicenseTypes()	getAllLicenseTypes.
List<CMSMultiRecordNote>	getAllMultiRecordNotes(boolean displayedNotesOnly)	Get all CMSMultiRecordNotes.
List<CMSRecordNote>	getAllRecordNotes()	Gets all persisted CMSRecordNotes.
List<Role>	getAllRoles()	getAllRoles.
List<Search>	getAllSearches()	getAllSearches.
List<CMSSlider>	getAllSliders()
List<CMSStaticPage>	getAllStaticPages()	getAllStaticPages.
List<CMSNavigationItem>	getAllTopCMSNavigationItems()	getAllTopCMSNavigationItems.
List<TranskribusJob>	getAllTranskribusJobs()	getAllTranskribusJobs.
List<DailySessionUsageStatistics>	getAllUsageStatistics()
List<UserGroup>	getAllUserGroups()	getAllUserGroups.
List<UserRole>	getAllUserRoles()	getAllUserRoles.
List<User>	getAllUsers(boolean refresh)	getAllUsers.
CrowdsourcingAnnotation	getAnnotation(Long id)	Annotations *.
long	getAnnotationCount(Map<String,String> filters)	getAnnotationCount.
long	getAnnotationCountForTarget(String pi, Integer page)	getAnnotationCountForTarget.
long	getAnnotationCountForWork(String pi)
List<CrowdsourcingAnnotation>	getAnnotations(int first, int pageSize, String sortField, boolean descending, String filterString, Map<String,Object> params)
List<CrowdsourcingAnnotation>	getAnnotations(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getAnnotations.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaign(Campaign campaign)	getAnnotationsForCampaign.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaignAndTarget(Campaign campaign, String pi, Integer page)	getAnnotationsForCampaignAndTarget.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaignAndWork(Campaign campaign, String pi)	getAnnotationsForCampaignAndWork.
List<CrowdsourcingAnnotation>	getAnnotationsForTarget(String pi, Integer page)	getAnnotationsForTarget.
List<CrowdsourcingAnnotation>	getAnnotationsForTarget(String pi, Integer page, String motivation)
List<CrowdsourcingAnnotation>	getAnnotationsForUserId(Long userId, Integer maxResults, String sortField, boolean descending)
List<CrowdsourcingAnnotation>	getAnnotationsForWork(String pi)	getAnnotationsForWork.
BookmarkList	getBookmarkList(long id)	getBookmarkList.
BookmarkList	getBookmarkList(String name, User user)	getBookmarkList.
BookmarkList	getBookmarkListByShareKey(String shareKey)	getBookmarkListByShareKey.
long	getBookmarkListCount(User user)	Gets number of bookmark lists owned by the given user.
List<BookmarkList>	getBookmarkLists(User user)	getBookmarkLists.
Campaign	getCampaign(Long id)	getCampaign.
long	getCampaignCount(Map<String,String> filters)	getCampaignCount.
List<CampaignRecordPageStatistic>	getCampaignPageStatisticsForRecord(String pi, CrowdsourcingStatus status)	getCampaignPageStatisticsForRecord.
List<Campaign>	getCampaigns(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getCampaigns.
List<CampaignRecordStatistic>	getCampaignStatisticsForRecord(String pi, CrowdsourcingStatus status)	getCampaignStatisticsForRecord.
CMSCategory	getCategory(Long id)	getCategory.
CMSCategory	getCategoryByName(String name)	getCategoryByName.
ClientApplication	getClientApplication(long id)
ClientApplication	getClientApplicationByClientId(String clientId)
long	getCMSArchiveConfigCount(Map<String,String> filters)	getCMSArchiveConfigCount.
Optional<CMSArchiveConfig>	getCmsArchiveConfigForArchive(String pi)
List<CMSArchiveConfig>	getCMSArchiveConfigs(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getCMSArchiveConfigs.
CMSCollection	getCMSCollection(String solrField, String solrFieldValue)	getCMSCollection.
List<CMSCollection>	getCMSCollections(String solrField)	getCMSCollections.
PersistentCMSComponent	getCMSComponent(Long id)
CMSMediaItem	getCMSMediaItem(long id)	getCMSMediaItem.
CMSMediaItem	getCMSMediaItemByFilename(String filename)	getCMSMediaItemByFilename.
List<CMSMediaItem>	getCMSMediaItemsByCategory(CMSCategory category)	Gets a list of all CMSMediaItems which contain the given category.
CMSNavigationItem	getCMSNavigationItem(long id)	getCMSNavigationItem.
CMSPage	getCMSPage(long id)	getCMSPage.
List<String>	getCMSPageAccessConditions()
long	getCMSPageCount(Map<String,String> filters, List<Long> allowedTemplates, List<String> allowedSubthemes, List<String> allowedCategories)	getCMSPageCount.
long	getCMSPageCountByPropertyValue(String propertyName, String propertyValue)
CMSPage	getCMSPageDefaultViewForRecord(String pi)
CMSPage	getCmsPageForStaticPage(String pageName)	getCmsPageForStaticPage.
List<CMSPage>	getCMSPages(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, List<Long> allowedTemplates, List<String> allowedSubthemes, List<String> allowedCategories)	getCMSPages.
List<CMSPage>	getCMSPagesByCategory(CMSCategory category)	getCMSPagesByCategory.
List<CMSPage>	getCMSPagesByPropertyValue(String propertyName, String propertyValue)
List<CMSPage>	getCMSPagesForRecord(String pi, CMSCategory category)	getCMSPagesForRecord.
List<CMSPage>	getCMSPagesForSubtheme(String subtheme)
List<CMSPage>	getCMSPagesWithRelatedPi(int first, int pageSize, LocalDateTime fromDate, LocalDateTime toDate)	getCMSPagesWithRelatedPi.
CMSPageTemplate	getCMSPageTemplate(Long id)
long	getCMSPageWithRelatedPiCount(LocalDateTime fromDate, LocalDateTime toDate)	getCMSPageWithRelatedPiCount.
Comment	getComment(long id)	getComment.
long	getCommentCount(Map<String,String> filters, User owner, Set<String> targetPIs)	getCommentCount.
CommentGroup	getCommentGroup(long id)	getCommentGroup.
CommentGroup	getCommentGroupUnfiltered()
List<Comment>	getComments(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, Set<String> targetPIs)	getComments.
List<Comment>	getCommentsForPage(String pi, int page)	getCommentsForPage.
List<Comment>	getCommentsForWork(String pi)	getCommentsForWork.
List<Comment>	getCommentsOfUser(User user, int maxResults, String sortField, boolean descending)	Gets Comments created by a specific user.
List<ThemeConfiguration>	getConfiguredThemes()
CookieBanner	getCookieBanner()
long	getCoreLicenseTypeCount(Map<String,String> filters)	getCoreLicenseTypeCount.
List<LicenseType>	getCoreLicenseTypes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getCoreLicenseTypes.
long	getCountMediaItemsUsingCategory(CMSCategory category)
long	getCountPagesUsingCategory(CMSCategory category)
CustomSidebarWidget	getCustomWidget(Long id)
Disclaimer	getDisclaimer()	Get the single stored Disclaimer.
EntityManager	getEntityManager()	Get a new EntityManager from the factory.
EntityManagerFactory	getFactory()	Getter for the field factory.
List<HighlightData>	getFutureHighlightsForDate(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, LocalDateTime date)
GeoMap	getGeoMap(Long mapId)	Gets the GeoMap of the given mapId.
HighlightData	getHighlight(Long id)
List<HighlightData>	getHighlights(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)
List<HighlightData>	getHighlightsForDate(LocalDateTime date)
IpRange	getIpRange(long id)	getIpRange.
IpRange	getIpRange(String name)	getIpRange.
long	getIpRangeCount(Map<String,String> filters)	getIpRangeCount.
List<IpRange>	getIpRanges(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getIpRanges.
License	getLicense(Long id)	getLicense.
long	getLicenseCount(LicenseType licenseType)	Returns the number of licenses that use the given license type.
List<License>	getLicenses(ILicensee licensee)
List<License>	getLicenses(LicenseType licenseType)
LicenseType	getLicenseType(long id)	getLicenseType.
LicenseType	getLicenseType(String name)	getLicenseType.
long	getLicenseTypeCount(Map<String,String> filters)	getLicenseTypeCount.
List<LicenseType>	getLicenseTypes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getLicenseTypes.
List<LicenseType>	getLicenseTypes(List<String> names)	Returns all license types that match the given name list.
MaintenanceMode	getMaintenanceMode()	Returns the only existing instance of MaintenanceMode.
List	getNativeQueryResults(String query)
Long	getNumRecordsWithComments(User user)
List<LicenseType>	getOverridingLicenseType(LicenseType licenseType)
List<CMSPage>	getPagesUsingMap(GeoMap map)	Returns a list of CMS-pages embedding the given map.
List<CMSPage>	getPagesUsingMapInSidebar(GeoMap map)	Returns a list of CMS-pages embedding the given map in a sidebar widget.
List<CMSPage>	getPagesUsingSlider(CMSSlider slider)
List<CMSPage>	getPagesUsingWidget(CustomSidebarWidget widget)
List<Integer>	getPagesWithComments(String pi)	getPagesWithComments.
List<HighlightData>	getPastHighlightsForDate(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, LocalDateTime date)
List<BookmarkList>	getPublicBookmarkLists()	getPublicBookmarkLists.
Question	getQuestion(Long id)	getQuestion.
List<LicenseType>	getRecordLicenseTypes()	getRecordLicenseTypes.
CMSRecordNote	getRecordNote(Long id)	Gets a CMSRecordNote by its id property.
List<CMSRecordNote>	getRecordNotes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	Gets a paginated list of CMSRecordNotes.
List<CMSSingleRecordNote>	getRecordNotesForPi(String pi, boolean displayedNotesOnly)	Gets all CMSRecordNotes for the given pi.
RecurringTaskTrigger	getRecurringTaskTrigger(Long id)
RecurringTaskTrigger	getRecurringTaskTriggerForTask(ITaskType task)
List<RecurringTaskTrigger>	getRecurringTaskTriggers()
List<CMSNavigationItem>	getRelatedNavItem(CMSPage page)	getRelatedNavItem.
Role	getRole(long id)	getRole.
Role	getRole(String name)	getRole.
long	getRoleCount(Map<String,String> filters)	getRoleCount.
List<Role>	getRoles(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getRoles.
Search	getSearch(long id)	getSearch.
long	getSearchCount(User owner, Map<String,String> filters)	getSearchCount.
List<Search>	getSearches(User owner)	getSearches.
List<Search>	getSearches(User owner, int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getSearches.
CMSSlider	getSlider(Long id)
List<CMSStaticPage>	getStaticPageForCMSPage(CMSPage page)	getStaticPageForCMSPage.
Optional<CMSStaticPage>	getStaticPageForTypeType(PageType pageType)	getStaticPageForTypeType.
TermsOfUse	getTermsOfUse()
ThemeConfiguration	getTheme(String name)
AccessTicket	getTicket(Long id)
AccessTicket	getTicketByPasswordHash(String passwordHash)
List<AccessTicket>	getTicketRequests()
long	getTotalAnnotationCount()
List<TranskribusJob>	getTranskribusJobs(String pi, String transkribusUserId, JobStatus status)	getTranskribusJobs.
List<UploadJob>	getUploadJobsForCreatorId(Long creatorId)
List<UploadJob>	getUploadJobsWithStatus(JobStatus status)
DailySessionUsageStatistics	getUsageStatistics(LocalDate date)
List<DailySessionUsageStatistics>	getUsageStatistics(LocalDate start, LocalDate end)
User	getUser(long id)	getUser.
User	getUserByEmail(String email)	getUserByEmail.
User	getUserByNickname(String nickname)	getUserByNickname.
User	getUserByOpenId(String identifier)	getUserByOpenId.
long	getUserCount(Map<String,String> filters)	getUserCount.
UserGroup	getUserGroup(long id)	getUserGroup.
UserGroup	getUserGroup(String name)	getUserGroup.
long	getUserGroupCount(Map<String,String> filters)	getUserGroupCount.
List<UserGroup>	getUserGroups(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getUserGroups.
List<UserGroup>	getUserGroups(User owner)	getUserGroups.
long	getUserRoleCount(UserGroup userGroup, User user, Role role)	getUserRoleCount.
List<UserRole>	getUserRoles(UserGroup userGroup, User user, Role role)	getUserRoles.
List<User>	getUsers(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getUsers.
List<User>	getUsersByPropertyValue(String propertyName, String propertyValue)
String	getUsersFilterQuery(String param)
ViewerMessage	getViewerMessage(Long id)
ViewerMessage	getViewerMessageByMessageID(String messageId)
long	getViewerMessageCount(Map<String,String> filters)	getViewerMessageCount.
List<ViewerMessage>	getViewerMessages(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getViewerMessages.
void	handleException(EntityManager em)	Handling of exceptions occurred during IDAO.commitTransaction(EntityManager) Usually calls EntityTransaction.rollback() on the current transaction of the given EntityManager.
void	handleException(EntityTransaction et)	Handling of exceptions occurred during IDAO.commitTransaction(EntityTransaction).
boolean	isCMSPagesForRecordHaveUpdates(String pi, CMSCategory category, LocalDateTime fromDate, LocalDateTime toDate)	isCMSPagesForRecordHaveUpdates.
void	preQuery()	Operation to call before getting an entity manager. currently noop
boolean	removeCMSPageTemplate(CMSPageTemplate template)
boolean	resetUserAgreementsToTermsOfUse()
boolean	saveClientApplication(ClientApplication client)
boolean	saveCMSArchiveConfig(CMSArchiveConfig config)	saveCMSArchiveConfig.
boolean	saveCookieBanner(CookieBanner banner)
boolean	saveDisclaimer(Disclaimer disclaimer)
boolean	saveTermsOfUse(TermsOfUse tou)
void	shutdown()	shutdown.
EntityTransaction	startTransaction(EntityManager em)	Call getTransaction() on the given EntityManager and then begin() on the transaction.
boolean	tableExists(String tableName)	tableExists.
boolean	updateAnnotation(CrowdsourcingAnnotation annotation)	updateAnnotation.
boolean	updateBookmarkList(BookmarkList bookmarkList)	updateBookmarkList.
boolean	updateCampaign(Campaign campaign)	updateCampaign.
boolean	updateCategory(CMSCategory category)	updateCategory.
boolean	updateCMSCollection(CMSCollection collection)	updateCMSCollection.
boolean	updateCMSMediaItem(CMSMediaItem item)	updateCMSMediaItem.
boolean	updateCMSNavigationItem(CMSNavigationItem item)	updateCMSNavigationItem.
boolean	updateCMSPage(CMSPage page)	updateCMSPage.
boolean	updateCMSPageTemplate(CMSPageTemplate template)
boolean	updateComment(Comment comment)	updateComment.
boolean	updateCommentGroup(CommentGroup commentGroup)	updateCommentGroup.
boolean	updateCustomWidget(CustomSidebarWidget widget)
boolean	updatedCMSComponent(PersistentCMSComponent persistentCMSComponent)
boolean	updateGeoMap(GeoMap map)	Updates the given GeoMap in the database.
boolean	updateHighlight(HighlightData object)
boolean	updateIpRange(IpRange ipRange)	updateIpRange.
boolean	updateLicense(License license)	updateLicenseType.
boolean	updateLicenseType(LicenseType licenseType)	updateLicenseType.
boolean	updateMaintenanceMode(MaintenanceMode maintenanceMode)	updateMaintenanceMode.
boolean	updateRecordNote(CMSRecordNote note)	Updates an existing CMSRecordNote.
boolean	updateRecurringTaskTrigger(RecurringTaskTrigger trigger)
boolean	updateRole(Role role)	updateRole.
boolean	updateSearch(Search search)	updateSearch.
boolean	updateSlider(CMSSlider slider)
boolean	updateStaticPage(CMSStaticPage page)	updateStaticPage.
boolean	updateTheme(ThemeConfiguration theme)
boolean	updateTicket(AccessTicket ticket)	updateTicket.
boolean	updateTranskribusJob(TranskribusJob job)	updateTranskribusJob.
boolean	updateUploadJob(UploadJob uploadJob)	updateDownloadJob.
boolean	updateUsageStatistics(DailySessionUsageStatistics statistics)
boolean	updateUser(User user)	updateUser.
boolean	updateUserGroup(UserGroup userGroup)	updateUserGroup.
boolean	updateUserRole(UserRole userRole)	updateUserRole.
boolean	updateViewerMessage(ViewerMessage message)

Methods inherited from class java.lang.Object

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

Constructor Details

JPADAO

public JPADAO()
       throws DAOException

Creates a new JPADAO instance.

Throws:

DAOException - if any.

JPADAO

public JPADAO(String inPersistenceUnitName)
       throws DAOException

Creates a new JPADAO instance.

Parameters:

inPersistenceUnitName - persistence unit name; uses default when null or empty

Throws:

DAOException - if any.

Method Details

getFactory

public EntityManagerFactory getFactory()

Getter for the field factory.

Specified by:

getFactory in interface IDAO

Returns:

the JPA EntityManagerFactory used by this DAO

getEntityManager

public EntityManager getEntityManager()

Get a new EntityManager from the factory.

Specified by:

getEntityManager in interface IDAO

Returns:

EntityManager for the current thread

close

public void close(EntityManager em)
           throws DAOException

Operation to call after a query or other kind of transaction is complete.

Specified by:

close in interface IDAO

Parameters:

em - entity manager to close

Throws:

DAOException

startTransaction

public EntityTransaction startTransaction(EntityManager em)

Call getTransaction() on the given EntityManager and then begin() on the transaction.

Specified by:

startTransaction in interface IDAO

Parameters:

em - the EntityManager whose transaction is started

Returns:

the transaction gotten from the entity manager

commitTransaction

public void commitTransaction(EntityTransaction et)
                       throws PersistenceException

Commits a persistence context transaction. Only to be used following a startTransaction(EntityManager) call

Specified by:

commitTransaction in interface IDAO

Parameters:

et - the active entity transaction to commit

Throws:

PersistenceException - if the commit fails

commitTransaction

public void commitTransaction(EntityManager em)
                       throws PersistenceException

Call EntityTransaction.commit() on the current transaction of the given EntityManager.

Specified by:

commitTransaction in interface IDAO

Parameters:

em - EntityManager

Throws:

PersistenceException

handleException

public void handleException(EntityTransaction et)
                     throws PersistenceException

Handling of exceptions occurred during IDAO.commitTransaction(EntityTransaction). Usually calls EntityTransaction.rollback()

Specified by:

handleException in interface IDAO

Parameters:

et - EntityTransaction

Throws:

PersistenceException

handleException

public void handleException(EntityManager em)

Handling of exceptions occurred during IDAO.commitTransaction(EntityManager) Usually calls EntityTransaction.rollback() on the current transaction of the given EntityManager.

Specified by:

handleException in interface IDAO

Parameters:

em - EntityManager

getAllUsers

public List<User> getAllUsers(boolean refresh)
                       throws DAOException

getAllUsers.

Specified by:

getAllUsers in interface IDAO

Parameters:

refresh - true to bypass cache and reload from database

Returns:

list of all users in the database

Throws:

DAOException - if any.

getUserCount

public long getUserCount(Map<String,String> filters)
                  throws DAOException

getUserCount.

Specified by:

getUserCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of users matching the given filters

Throws:

DAOException - if any.

getUsers

public List<User> getUsers(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                    throws DAOException

getUsers.

Specified by:

getUsers in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of users matching the given criteria

Throws:

DAOException - if any.

getUsersByPropertyValue

public List<User> getUsersByPropertyValue(String propertyName,
 String propertyValue)
                                   throws DAOException

Specified by:

getUsersByPropertyValue in interface IDAO

Parameters:

propertyName - name of the user property to filter by

propertyValue - value of the user property to filter by

Returns:

List if users with matching property name/value pair

Throws:

DAOException

getAdminUsers

public List<User> getAdminUsers()
                         throws DAOException

Specified by:

getAdminUsers in interface IDAO

Returns:

List where User.superuser == true

Throws:

DAOException

getUsersFilterQuery

public String getUsersFilterQuery(String param)

Parameters:

param - named query parameter placeholder for filter values

Returns:

Generated query

getUser

public User getUser(long id)
             throws DAOException

getUser.

Specified by:

getUser in interface IDAO

Parameters:

id - database primary key of the user

Returns:

the matching user, or null if not found

Throws:

DAOException - if any.

getUserByEmail

public User getUserByEmail(String email)
                    throws DAOException

getUserByEmail.

Specified by:

getUserByEmail in interface IDAO

Parameters:

email - email address of the user to look up

Returns:

the matching user, or null if not found

Throws:

DAOException - if any.

getUserByOpenId

public User getUserByOpenId(String identifier)
                     throws DAOException

getUserByOpenId.

Specified by:

getUserByOpenId in interface IDAO

Parameters:

identifier - OpenID identifier of the user to look up

Returns:

the matching user, or null if not found

Throws:

DAOException - if any.

getUserByNickname

public User getUserByNickname(String nickname)
                       throws DAOException

Description copied from interface: IDAO

getUserByNickname.

Specified by:

getUserByNickname in interface IDAO

Parameters:

nickname - user nickname to look up (case-insensitive)

Returns:

the User with the given nickname, or null if not found or nickname is blank

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getUserByNickname(java.lang.String)

addUser

public boolean addUser(User user)
                throws DAOException

addUser.

Specified by:

addUser in interface IDAO

Parameters:

user - user to persist

Returns:

true if user was added successfully; false otherwise

Throws:

DAOException - if any.

updateUser

public boolean updateUser(User user)
                   throws DAOException

updateUser.

Specified by:

updateUser in interface IDAO

Parameters:

user - user to update in the database

Returns:

true if user was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteUser

public boolean deleteUser(User user)
                   throws DAOException

deleteUser.

Specified by:

deleteUser in interface IDAO

Parameters:

user - user to delete from the database

Returns:

true if user was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllUserGroups

public List<UserGroup> getAllUserGroups()
                                 throws DAOException

getAllUserGroups.

Specified by:

getAllUserGroups in interface IDAO

Returns:

list of all user groups in the database

Throws:

DAOException - if any.

getUserGroups

public List<UserGroup> getUserGroups(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                              throws DAOException

getUserGroups.

Specified by:

getUserGroups in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of user groups matching the given criteria

Throws:

DAOException - if any.

getUserGroups

public List<UserGroup> getUserGroups(User owner)
                              throws DAOException

getUserGroups.

Specified by:

getUserGroups in interface IDAO

Parameters:

owner - user who owns the groups to retrieve

Returns:

list of user groups owned by the given user

Throws:

DAOException - if any.

getUserGroup

public UserGroup getUserGroup(long id)
                       throws DAOException

getUserGroup.

Specified by:

getUserGroup in interface IDAO

Parameters:

id - database primary key of the user group

Returns:

the matching user group, or null if not found

Throws:

DAOException - if any.

getUserGroup

public UserGroup getUserGroup(String name)
                       throws DAOException

getUserGroup.

Specified by:

getUserGroup in interface IDAO

Parameters:

name - name of the user group to look up

Returns:

the matching user group, or null if not found

Throws:

DAOException - if any.

addUserGroup

public boolean addUserGroup(UserGroup userGroup)
                     throws DAOException

addUserGroup.

Specified by:

addUserGroup in interface IDAO

Parameters:

userGroup - user group to persist

Returns:

true if user group was added successfully; false otherwise

Throws:

DAOException - if any.

updateUserGroup

public boolean updateUserGroup(UserGroup userGroup)
                        throws DAOException

updateUserGroup.

Specified by:

updateUserGroup in interface IDAO

Parameters:

userGroup - user group to update in the database

Returns:

true if user group was updated successfully; false otherwise

Throws:

DAOException - if any.

See Also:

• IDAO.updateUserGroup(io.goobi.viewer.model.security.user.UserGroup)

deleteUserGroup

public boolean deleteUserGroup(UserGroup userGroup)
                        throws DAOException

deleteUserGroup.

Specified by:

deleteUserGroup in interface IDAO

Parameters:

userGroup - user group to delete from the database

Returns:

true if user group was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllBookmarkLists

public List<BookmarkList> getAllBookmarkLists()
                                       throws DAOException

getAllBookmarkLists.

Specified by:

getAllBookmarkLists in interface IDAO

Returns:

list of all bookmark lists in the database

Throws:

DAOException - if any.

getPublicBookmarkLists

public List<BookmarkList> getPublicBookmarkLists()
                                          throws DAOException

getPublicBookmarkLists.

Specified by:

getPublicBookmarkLists in interface IDAO

Returns:

list of all publicly visible bookmark lists

Throws:

DAOException - if any.

getBookmarkLists

public List<BookmarkList> getBookmarkLists(User user)
                                    throws DAOException

getBookmarkLists.

Specified by:

getBookmarkLists in interface IDAO

Parameters:

user - owner of the bookmark lists to retrieve

Returns:

list of bookmark lists owned by the given user

Throws:

DAOException - if any.

getBookmarkListCount

public long getBookmarkListCount(User user)
                          throws DAOException

Gets number of bookmark lists owned by the given user.

Specified by:

getBookmarkListCount in interface IDAO

Parameters:

user - owner of the bookmark lists

Returns:

number of owned bookmark lists

Throws:

DAOException

getBookmarkList

public BookmarkList getBookmarkList(long id)
                             throws DAOException

getBookmarkList.

Specified by:

getBookmarkList in interface IDAO

Parameters:

id - database primary key of the bookmark list

Returns:

the matching bookmark list, or null if not found

Throws:

DAOException - if any.

getBookmarkList

public BookmarkList getBookmarkList(String name,
 User user)
                             throws DAOException

getBookmarkList.

Specified by:

getBookmarkList in interface IDAO

Parameters:

name - name of the bookmark list to look up

user - owner of the bookmark list

Returns:

the matching bookmark list, or null if not found

Throws:

DAOException - if any.

getBookmarkListByShareKey

public BookmarkList getBookmarkListByShareKey(String shareKey)
                                       throws DAOException

getBookmarkListByShareKey.

Specified by:

getBookmarkListByShareKey in interface IDAO

Parameters:

shareKey - share key identifying the bookmark list

Returns:

the matching bookmark list, or null if not found

Throws:

DAOException - if any.

addBookmarkList

public boolean addBookmarkList(BookmarkList bookmarkList)
                        throws DAOException

addBookmarkList.

Specified by:

addBookmarkList in interface IDAO

Parameters:

bookmarkList - bookmark list to persist

Returns:

true if bookmark list was added successfully; false otherwise

Throws:

DAOException - if any.

updateBookmarkList

public boolean updateBookmarkList(BookmarkList bookmarkList)
                           throws DAOException

updateBookmarkList.

Specified by:

updateBookmarkList in interface IDAO

Parameters:

bookmarkList - bookmark list to update in the database

Returns:

true if bookmark list was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteBookmarkList

public boolean deleteBookmarkList(BookmarkList bookmarkList)
                           throws DAOException

deleteBookmarkList.

Specified by:

deleteBookmarkList in interface IDAO

Parameters:

bookmarkList - bookmark list to delete from the database

Returns:

true if bookmark list was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllRoles

public List<Role> getAllRoles()
                       throws DAOException

getAllRoles.

Specified by:

getAllRoles in interface IDAO

Returns:

list of all roles in the database

Throws:

DAOException - if any.

getRoles

public List<Role> getRoles(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                    throws DAOException

getRoles.

Specified by:

getRoles in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of roles matching the given criteria

Throws:

DAOException - if any.

getRole

public Role getRole(long id)
             throws DAOException

getRole.

Specified by:

getRole in interface IDAO

Parameters:

id - database primary key of the role

Returns:

the matching role, or null if not found

Throws:

DAOException - if any.

getRole

public Role getRole(String name)
             throws DAOException

getRole.

Specified by:

getRole in interface IDAO

Parameters:

name - name of the role to look up

Returns:

the matching role, or null if not found

Throws:

DAOException - if any.

addRole

public boolean addRole(Role role)
                throws DAOException

addRole.

Specified by:

addRole in interface IDAO

Parameters:

role - role to persist

Returns:

true if role was added successfully; false otherwise

Throws:

DAOException - if any.

updateRole

public boolean updateRole(Role role)
                   throws DAOException

updateRole.

Specified by:

updateRole in interface IDAO

Parameters:

role - role to update in the database

Returns:

true if role was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteRole

public boolean deleteRole(Role role)
                   throws DAOException

deleteRole.

Specified by:

deleteRole in interface IDAO

Parameters:

role - role to delete from the database

Returns:

true if role was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllUserRoles

public List<UserRole> getAllUserRoles()
                               throws DAOException

getAllUserRoles.

Specified by:

getAllUserRoles in interface IDAO

Returns:

list of all user role assignments in the database

Throws:

DAOException - if any.

getUserRoleCount

public long getUserRoleCount(UserGroup userGroup,
 User user,
 Role role)
                      throws DAOException

Description copied from interface: IDAO

getUserRoleCount.

Specified by:

getUserRoleCount in interface IDAO

Parameters:

userGroup - user group to filter by, or null to match any group

user - user to filter by, or null to match any user

role - role to filter by, or null to match any role

Returns:

the number of user role assignments matching the given filter criteria

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getUserRoleCount(io.goobi.viewer.model.security.user.UserGroup, io.goobi.viewer.model.security.user.User, io.goobi.viewer.model.security.Role)

getUserRoles

public List<UserRole> getUserRoles(UserGroup userGroup,
 User user,
 Role role)
                            throws DAOException

getUserRoles.

Specified by:

getUserRoles in interface IDAO

Parameters:

userGroup - user group to filter by, or null to ignore

user - user to filter by, or null to ignore

role - role to filter by, or null to ignore

Returns:

list of user role assignments matching the given filters

Throws:

DAOException - if any.

addUserRole

public boolean addUserRole(UserRole userRole)
                    throws DAOException

addUserRole.

Specified by:

addUserRole in interface IDAO

Parameters:

userRole - user role assignment to persist

Returns:

true if user role was added successfully; false otherwise

Throws:

DAOException - if any.

updateUserRole

public boolean updateUserRole(UserRole userRole)
                       throws DAOException

updateUserRole.

Specified by:

updateUserRole in interface IDAO

Parameters:

userRole - user role assignment to update in the database

Returns:

true if user role was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteUserRole

public boolean deleteUserRole(UserRole userRole)
                       throws DAOException

deleteUserRole.

Specified by:

deleteUserRole in interface IDAO

Parameters:

userRole - user role assignment to delete from the database

Returns:

true if user role was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllLicenseTypes

public List<LicenseType> getAllLicenseTypes()
                                     throws DAOException

getAllLicenseTypes.

Specified by:

getAllLicenseTypes in interface IDAO

Returns:

list of all license types in the database

Throws:

DAOException - if any.

getRecordLicenseTypes

public List<LicenseType> getRecordLicenseTypes()
                                        throws DAOException

getRecordLicenseTypes.

Specified by:

getRecordLicenseTypes in interface IDAO

Returns:

list of license types that apply at the record level

Throws:

DAOException - if any.

getLicenseTypes

public List<LicenseType> getLicenseTypes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                  throws DAOException

getLicenseTypes.

Specified by:

getLicenseTypes in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of license types matching the given criteria

Throws:

DAOException - if any.

getCoreLicenseTypes

public List<LicenseType> getCoreLicenseTypes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                      throws DAOException

getCoreLicenseTypes.

Specified by:

getCoreLicenseTypes in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of core license types matching the given criteria

Throws:

DAOException - if any.

getLicenseType

public LicenseType getLicenseType(long id)
                           throws DAOException

getLicenseType.

Specified by:

getLicenseType in interface IDAO

Parameters:

id - database primary key of the license type

Returns:

the matching license type, or null if not found

Throws:

DAOException - if any.

getLicenseType

public LicenseType getLicenseType(String name)
                           throws DAOException

getLicenseType.

Specified by:

getLicenseType in interface IDAO

Parameters:

name - name of the license type to look up

Returns:

the matching license type, or null if not found

Throws:

DAOException - if any.

getLicenseTypes

public List<LicenseType> getLicenseTypes(List<String> names)
                                  throws DAOException

Description copied from interface: IDAO

Returns all license types that match the given name list.

Specified by:

getLicenseTypes in interface IDAO

Parameters:

names - list of license type names to retrieve; returns empty list if null or empty

Returns:

the list of LicenseType objects whose names match the given list, or an empty list if no matches are found

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getLicenseTypes(java.util.List)

getOverridingLicenseType

public List<LicenseType> getOverridingLicenseType(LicenseType licenseType)
                                           throws DAOException

Specified by:

getOverridingLicenseType in interface IDAO

Parameters:

licenseType - the license type for which to find overriding license types

Returns:

the list of license types that override the given license type, or an empty list if none exist

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getOverridingLicenseType(io.goobi.viewer.model.security.LicenseType)

addLicenseType

public boolean addLicenseType(LicenseType licenseType)
                       throws DAOException

addLicenseType.

Specified by:

addLicenseType in interface IDAO

Parameters:

licenseType - license type to persist

Returns:

true if license type was added successfully; false otherwise

Throws:

DAOException - if any.

updateLicenseType

public boolean updateLicenseType(LicenseType licenseType)
                          throws DAOException

updateLicenseType.

Specified by:

updateLicenseType in interface IDAO

Parameters:

licenseType - license type to update in the database

Returns:

true if license type was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteLicenseType

public boolean deleteLicenseType(LicenseType licenseType)
                          throws DAOException

deleteLicenseType.

Specified by:

deleteLicenseType in interface IDAO

Parameters:

licenseType - license type to delete from the database

Returns:

true if license type was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllLicenses

public List<License> getAllLicenses()
                             throws DAOException

getAllLicenses.

Specified by:

getAllLicenses in interface IDAO

Returns:

list of all licenses in the database

Throws:

DAOException - if any.

getLicense

public License getLicense(Long id)
                   throws DAOException

getLicense.

Specified by:

getLicense in interface IDAO

Parameters:

id - database primary key of the license

Returns:

the matching license, or null if not found

Throws:

DAOException - if any.

getLicenses

public List<License> getLicenses(LicenseType licenseType)
                          throws DAOException

Specified by:

getLicenses in interface IDAO

Parameters:

licenseType - the license type whose associated licenses are retrieved; must not be null

Returns:

the list of License objects associated with the given license type

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getLicenses(io.goobi.viewer.model.security.LicenseType)

getLicenses

public List<License> getLicenses(ILicensee licensee)
                          throws DAOException

Specified by:

getLicenses in interface IDAO

Parameters:

licensee - licensee (user, group, or IP range) to filter by

Returns:

List of Licenses for the given licensee

Throws:

DAOException

getLicenseCount

public long getLicenseCount(LicenseType licenseType)
                     throws DAOException

Description copied from interface: IDAO

Returns the number of licenses that use the given license type.

Specified by:

getLicenseCount in interface IDAO

Parameters:

licenseType - the license type whose associated licenses are counted; must not be null

Returns:

the number of License objects associated with the given license type

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getLicenseCount(io.goobi.viewer.model.security.LicenseType)

addLicense

public boolean addLicense(License license)
                   throws DAOException

addLicenseType.

Specified by:

addLicense in interface IDAO

Parameters:

license - license to persist

Returns:

true if license was added successfully; false otherwise

Throws:

DAOException - if any.

updateLicense

public boolean updateLicense(License license)
                      throws DAOException

updateLicenseType.

Specified by:

updateLicense in interface IDAO

Parameters:

license - license to update in the database

Returns:

true if license was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteLicense

public boolean deleteLicense(License license)
                      throws DAOException

deleteLicenseType.

Specified by:

deleteLicense in interface IDAO

Parameters:

license - license to delete from the database

Returns:

true if license was deleted successfully; false otherwise

Throws:

DAOException - if any.

getTicket

public AccessTicket getTicket(Long id)
                       throws DAOException

Specified by:

getTicket in interface IDAO

Parameters:

id - database id of the access ticket

Returns:

AccessTicket with the given id

Throws:

DAOException

getTicketByPasswordHash

public AccessTicket getTicketByPasswordHash(String passwordHash)
                                     throws DAOException

Specified by:

getTicketByPasswordHash in interface IDAO

Parameters:

passwordHash - password hash of the access ticket

Returns:

AccessTicket with the given passwordHash

Throws:

DAOException

getActiveTicketCount

public long getActiveTicketCount(Map<String,String> filters)
                          throws DAOException

getActiveTicketCount.

Specified by:

getActiveTicketCount in interface IDAO

Parameters:

filters - Selected filters

Returns:

Number of found rows

Throws:

DAOException - if any.

getActiveTickets

public List<AccessTicket> getActiveTickets(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                    throws DAOException

getActiveRecordAccessTickets.

Specified by:

getActiveTickets in interface IDAO

Parameters:

first - First row index

pageSize - Number of rows

sortField - field to sort by

descending - true if descending order requested; false otherwise

filters - Selected filters

Returns:

list of active access tickets matching the given criteria

Throws:

DAOException - if any.

getTicketRequests

public List<AccessTicket> getTicketRequests()
                                     throws DAOException

Specified by:

getTicketRequests in interface IDAO

Returns:

AccessTickets with the requested status

Throws:

DAOException

addTicket

public boolean addTicket(AccessTicket ticket)
                  throws DAOException

addTicket.

Specified by:

addTicket in interface IDAO

Parameters:

ticket - access ticket to persist

Returns:

true if ticket was added successfully; false otherwise

Throws:

DAOException - if any.

updateTicket

public boolean updateTicket(AccessTicket ticket)
                     throws DAOException

updateTicket.

Specified by:

updateTicket in interface IDAO

Parameters:

ticket - access ticket to update in the database

Returns:

true if ticket was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteTicket

public boolean deleteTicket(AccessTicket ticket)
                     throws DAOException

deleteTicket.

Specified by:

deleteTicket in interface IDAO

Parameters:

ticket - access ticket to delete from the database

Returns:

true if ticket was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllIpRanges

public List<IpRange> getAllIpRanges()
                             throws DAOException

getAllIpRanges.

Specified by:

getAllIpRanges in interface IDAO

Returns:

list of all IP ranges in the database

Throws:

DAOException - if any.

getIpRanges

public List<IpRange> getIpRanges(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                          throws DAOException

getIpRanges.

Specified by:

getIpRanges in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of IP ranges matching the given criteria

Throws:

DAOException - if any.

getIpRange

public IpRange getIpRange(long id)
                   throws DAOException

getIpRange.

Specified by:

getIpRange in interface IDAO

Parameters:

id - database primary key of the IP range

Returns:

the matching IP range, or null if not found

Throws:

DAOException - if any.

getIpRange

public IpRange getIpRange(String name)
                   throws DAOException

getIpRange.

Specified by:

getIpRange in interface IDAO

Parameters:

name - name of the IP range to look up

Returns:

the matching IP range, or null if not found

Throws:

DAOException - if any.

addIpRange

public boolean addIpRange(IpRange ipRange)
                   throws DAOException

addIpRange.

Specified by:

addIpRange in interface IDAO

Parameters:

ipRange - IP range to persist

Returns:

true if IP range was added successfully; false otherwise

Throws:

DAOException - if any.

updateIpRange

public boolean updateIpRange(IpRange ipRange)
                      throws DAOException

updateIpRange.

Specified by:

updateIpRange in interface IDAO

Parameters:

ipRange - IP range to update in the database

Returns:

true if IP range was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteIpRange

public boolean deleteIpRange(IpRange ipRange)
                      throws DAOException

deleteIpRange.

Specified by:

deleteIpRange in interface IDAO

Parameters:

ipRange - IP range to delete from the database

Returns:

true if IP range was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllCommentGroups

public List<CommentGroup> getAllCommentGroups()
                                       throws DAOException

Specified by:

getAllCommentGroups in interface IDAO

Returns:

the list of all comment groups persisted in the database

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getAllCommentGroups()

getCommentGroupUnfiltered

public CommentGroup getCommentGroupUnfiltered()
                                       throws DAOException

Specified by:

getCommentGroupUnfiltered in interface IDAO

Returns:

the core (unfiltered) comment group, or null if none exists

Throws:

DAOException

See Also:

• IDAO.getCommentGroupUnfiltered()

getCommentGroup

public CommentGroup getCommentGroup(long id)
                             throws DAOException

Description copied from interface: IDAO

getCommentGroup.

Specified by:

getCommentGroup in interface IDAO

Parameters:

id - database ID of the comment group to retrieve

Returns:

the CommentGroup with the given ID, or null if not found

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.getCommentGroup(long)

addCommentGroup

public boolean addCommentGroup(CommentGroup commentGroup)
                        throws DAOException

Description copied from interface: IDAO

addCommentGroup.

Specified by:

addCommentGroup in interface IDAO

Parameters:

commentGroup - the comment group to persist in the database

Returns:

true if the comment group was successfully persisted, false if a persistence error occurred

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.addCommentGroup(io.goobi.viewer.model.annotation.comments.CommentGroup)

updateCommentGroup

public boolean updateCommentGroup(CommentGroup commentGroup)
                           throws DAOException

Description copied from interface: IDAO

updateCommentGroup.

Specified by:

updateCommentGroup in interface IDAO

Parameters:

commentGroup - the comment group with updated values to merge into the database

Returns:

true if the comment group was successfully updated, false if a persistence error occurred

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.updateCommentGroup(io.goobi.viewer.model.annotation.comments.CommentGroup)

deleteCommentGroup

public boolean deleteCommentGroup(CommentGroup commentGroup)
                           throws DAOException

Description copied from interface: IDAO

deleteCommentGroup.

Specified by:

deleteCommentGroup in interface IDAO

Parameters:

commentGroup - the comment group to remove from the database

Returns:

true if the comment group was successfully deleted, false if a persistence error occurred

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.deleteCommentGroup(io.goobi.viewer.model.annotation.comments.CommentGroup)

getAllComments

public List<Comment> getAllComments()
                             throws DAOException

getAllComments.

Specified by:

getAllComments in interface IDAO

Returns:

list of all comments in the database

Throws:

DAOException - if any.

getComments

public List<Comment> getComments(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 Set<String> targetPIs)
                          throws DAOException

getComments.

Specified by:

getComments in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

targetPIs - set of persistent identifiers to restrict results to

Returns:

list of comments matching the given criteria

Throws:

DAOException - if any.

getCommentsOfUser

public List<Comment> getCommentsOfUser(User user,
 int maxResults,
 String sortField,
 boolean descending)
                                throws DAOException

Gets Comments created by a specific user.

Specified by:

getCommentsOfUser in interface IDAO

Parameters:

user - the creator/owner of the comment

maxResults - maximum number of results to return

sortField - class field to sort results by

descending - set to "true" to sort descending

Returns:

A list of at most maxResults comments.

Throws:

DAOException

getCommentsForPage

public List<Comment> getCommentsForPage(String pi,
 int page)
                                 throws DAOException

getCommentsForPage.

Specified by:

getCommentsForPage in interface IDAO

Parameters:

pi - persistent identifier of the record

page - page order number within the record

Returns:

list of comments for the given record page

Throws:

DAOException - if any.

getCommentsForWork

public List<Comment> getCommentsForWork(String pi)
                                 throws DAOException

getCommentsForWork.

Specified by:

getCommentsForWork in interface IDAO

Parameters:

pi - persistent identifier of the record

Returns:

list of all comments for the given record

Throws:

DAOException - if any.

countCommentsForWork

public long countCommentsForWork(String pi)
                          throws DAOException

countCommentsForWork.

Specified by:

countCommentsForWork in interface IDAO

Parameters:

pi - persistent identifier of the record

Returns:

the total number of comments for the record with the given persistent identifier

Throws:

DAOException - if any.

getComment

public Comment getComment(long id)
                   throws DAOException

getComment.

Specified by:

getComment in interface IDAO

Parameters:

id - database primary key of the comment

Returns:

the matching comment, or null if not found

Throws:

DAOException - if any.

addComment

public boolean addComment(Comment comment)
                   throws DAOException

addComment.

Specified by:

addComment in interface IDAO

Parameters:

comment - comment to persist

Returns:

true if comment was added successfully; false otherwise

Throws:

DAOException - if any.

updateComment

public boolean updateComment(Comment comment)
                      throws DAOException

updateComment.

Specified by:

updateComment in interface IDAO

Parameters:

comment - comment to update in the database

Returns:

true if comment was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteComment

public boolean deleteComment(Comment comment)
                      throws DAOException

deleteComment.

Specified by:

deleteComment in interface IDAO

Parameters:

comment - comment to delete from the database

Returns:

true if comment was deleted successfully; false otherwise

Throws:

DAOException - if any.

changeCommentsOwner

public int changeCommentsOwner(User fromUser,
 User toUser)
                        throws DAOException

Changes ownership of all comments from fromUser to toUser.

Specified by:

changeCommentsOwner in interface IDAO

Parameters:

fromUser - user whose comments are to be reassigned

toUser - user to reassign the comments to

Returns:

Number of updated Comments

Throws:

DAOException - if any.

deleteComments

public int deleteComments(String pi,
 User owner)
                   throws DAOException

Specified by:

deleteComments in interface IDAO

Parameters:

pi - persistent identifier to restrict deletion to comments on a specific record, or null for any

owner - user whose comments should be deleted, or null to delete regardless of owner

Returns:

the number of comments deleted

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.deleteComments(java.lang.String, io.goobi.viewer.model.security.user.User)

getPagesWithComments

public List<Integer> getPagesWithComments(String pi)
                                   throws DAOException

getPagesWithComments.

Gets all page numbers (order) within a work with the given pi which contain comments

Specified by:

getPagesWithComments in interface IDAO

Parameters:

pi - persistent identifier of the record

Returns:

list of page order numbers that have at least one comment in the given record

Throws:

DAOException - if any.

getAllSearches

public List<Search> getAllSearches()
                            throws DAOException

getAllSearches.

Specified by:

getAllSearches in interface IDAO

Returns:

list of all saved searches in the database

Throws:

DAOException - if any.

getSearchCount

public long getSearchCount(User owner,
 Map<String,String> filters)
                    throws DAOException

getSearchCount.

Specified by:

getSearchCount in interface IDAO

Parameters:

owner - user who owns the searches, or null for all users

filters - map of field names to filter values

Returns:

total number of saved searches matching the given criteria

Throws:

DAOException - if any.

getSearches

public List<Search> getSearches(User owner,
 int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                         throws DAOException

getSearches.

Specified by:

getSearches in interface IDAO

Parameters:

owner - user who owns the searches, or null for all users

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of saved searches matching the given criteria

Throws:

DAOException - if any.

getSearches

public List<Search> getSearches(User owner)
                         throws DAOException

getSearches.

Specified by:

getSearches in interface IDAO

Parameters:

owner - user whose saved searches to retrieve

Returns:

list of saved searches owned by the given user

Throws:

DAOException - if any.

getSearch

public Search getSearch(long id)
                 throws DAOException

getSearch.

Specified by:

getSearch in interface IDAO

Parameters:

id - database primary key of the search

Returns:

the matching saved search, or null if not found

Throws:

DAOException - if any.

addSearch

public boolean addSearch(Search search)
                  throws DAOException

addSearch.

Specified by:

addSearch in interface IDAO

Parameters:

search - saved search to persist

Returns:

true if search was added successfully; false otherwise

Throws:

DAOException - if any.

updateSearch

public boolean updateSearch(Search search)
                     throws DAOException

updateSearch.

Specified by:

updateSearch in interface IDAO

Parameters:

search - saved search to update in the database

Returns:

true if search was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteSearch

public boolean deleteSearch(Search search)
                     throws DAOException

deleteSearch.

Specified by:

deleteSearch in interface IDAO

Parameters:

search - saved search to delete from the database

Returns:

true if search was deleted successfully; false otherwise

Throws:

DAOException - if any.

getUploadJobsWithStatus

public List<UploadJob> getUploadJobsWithStatus(JobStatus status)
                                        throws DAOException

Specified by:

getUploadJobsWithStatus in interface IDAO

Parameters:

status - JobStatus

Returns:

List of UploadJobs with given status

Throws:

DAOException

getUploadJobsForCreatorId

public List<UploadJob> getUploadJobsForCreatorId(Long creatorId)
                                          throws DAOException

Specified by:

getUploadJobsForCreatorId in interface IDAO

Parameters:

creatorId - User id of the creator

Returns:

UploadJobs belonging to user with given ID

Throws:

DAOException - if any.

addUploadJob

public boolean addUploadJob(UploadJob uploadJob)
                     throws DAOException

addDownloadJob.

Specified by:

addUploadJob in interface IDAO

Parameters:

uploadJob - upload job to persist

Returns:

true if upload job was added successfully; false otherwise

Throws:

DAOException - if any.

updateUploadJob

public boolean updateUploadJob(UploadJob uploadJob)
                        throws DAOException

updateDownloadJob.

Specified by:

updateUploadJob in interface IDAO

Parameters:

uploadJob - upload job to update in the database

Returns:

true if upload job was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteUploadJob

public boolean deleteUploadJob(UploadJob uploadJob)
                        throws DAOException

deleteDownloadJob.

Specified by:

deleteUploadJob in interface IDAO

Parameters:

uploadJob - upload job to delete from the database

Returns:

true if upload job was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllCMSPages

public List<CMSPage> getAllCMSPages()
                             throws DAOException

getAllCMSPages.

Specified by:

getAllCMSPages in interface IDAO

Returns:

list of all CMS pages in the database

Throws:

DAOException - if any.

getCmsPageForStaticPage

public CMSPage getCmsPageForStaticPage(String pageName)
                                throws DAOException

getCmsPageForStaticPage.

Specified by:

getCmsPageForStaticPage in interface IDAO

Parameters:

pageName - static page name identifying the CMS page

Returns:

the CMS page associated with the given static page name, or null if not found

Throws:

DAOException - if any.

getCMSPages

public List<CMSPage> getCMSPages(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 List<Long> allowedTemplates,
 List<String> allowedSubthemes,
 List<String> allowedCategories)
                          throws DAOException

getCMSPages.

Specified by:

getCMSPages in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

allowedTemplates - list of template IDs the user is allowed to see

allowedSubthemes - list of subtheme identifiers the user is allowed to see

allowedCategories - list of category names the user is allowed to see

Returns:

list of CMS pages matching the given filters and permissions

Throws:

DAOException - if any.

getCMSPagesWithRelatedPi

public List<CMSPage> getCMSPagesWithRelatedPi(int first,
 int pageSize,
 LocalDateTime fromDate,
 LocalDateTime toDate)
                                       throws DAOException

getCMSPagesWithRelatedPi.

Specified by:

getCMSPagesWithRelatedPi in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

fromDate - lower bound of the date range filter, or null

toDate - upper bound of the date range filter, or null

Returns:

list of CMS pages that have a related persistent identifier within the given date range

Throws:

DAOException - if any.

isCMSPagesForRecordHaveUpdates

public boolean isCMSPagesForRecordHaveUpdates(String pi,
 CMSCategory category,
 LocalDateTime fromDate,
 LocalDateTime toDate)
                                       throws DAOException

isCMSPagesForRecordHaveUpdates.

Specified by:

isCMSPagesForRecordHaveUpdates in interface IDAO

Parameters:

pi - persistent identifier of the record

category - category to filter CMS pages by, or null for all categories

fromDate - lower bound of the date range filter, or null

toDate - upper bound of the date range filter, or null

Returns:

true if any CMS pages for the record have been updated within the given date range; false otherwise

Throws:

DAOException - if any.

getCMSPageWithRelatedPiCount

public long getCMSPageWithRelatedPiCount(LocalDateTime fromDate,
 LocalDateTime toDate)
                                  throws DAOException

getCMSPageWithRelatedPiCount.

Specified by:

getCMSPageWithRelatedPiCount in interface IDAO

Parameters:

fromDate - lower bound of the date range filter, or null

toDate - upper bound of the date range filter, or null

Returns:

total number of CMS pages with a related persistent identifier within the given date range

Throws:

DAOException - if any.

getCMSPageDefaultViewForRecord

public CMSPage getCMSPageDefaultViewForRecord(String pi)
                                       throws DAOException

Specified by:

getCMSPageDefaultViewForRecord in interface IDAO

Parameters:

pi - Record identifier

Returns:

CMSPage

Throws:

DAOException

getCMSPageAccessConditions

public List<String> getCMSPageAccessConditions()
                                        throws DAOException

Specified by:

getCMSPageAccessConditions in interface IDAO

Returns:

List

Throws:

DAOException

getCMSPage

public CMSPage getCMSPage(long id)
                   throws DAOException

getCMSPage.

Specified by:

getCMSPage in interface IDAO

Parameters:

id - database primary key of the CMS page

Returns:

the matching CMS page, or null if not found

Throws:

DAOException - if any.

getRelatedNavItem

public List<CMSNavigationItem> getRelatedNavItem(CMSPage page)
                                          throws DAOException

getRelatedNavItem.

Specified by:

getRelatedNavItem in interface IDAO

Parameters:

page - CMS page whose related navigation items to retrieve

Returns:

list of CMS navigation items linking to the given page

Throws:

DAOException - if any.

addCMSPage

public boolean addCMSPage(CMSPage page)
                   throws DAOException

addCMSPage.

Specified by:

addCMSPage in interface IDAO

Parameters:

page - CMS page to persist

Returns:

true if CMS page was added successfully; false otherwise

Throws:

DAOException - if any.

updateCMSPage

public boolean updateCMSPage(CMSPage page)
                      throws DAOException

updateCMSPage.

Specified by:

updateCMSPage in interface IDAO

Parameters:

page - CMS page to update in the database

Returns:

true if CMS page was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCMSPage

public boolean deleteCMSPage(CMSPage page)
                      throws DAOException

deleteCMSPage.

Specified by:

deleteCMSPage in interface IDAO

Parameters:

page - CMS page to delete from the database

Returns:

true if CMS page was deleted successfully; false otherwise

Throws:

DAOException - if any.

deleteCMSComponent

public boolean deleteCMSComponent(PersistentCMSComponent component)
                           throws DAOException

Specified by:

deleteCMSComponent in interface IDAO

Throws:

DAOException

deleteCMSContent

public boolean deleteCMSContent(CMSContent content)
                         throws DAOException

Specified by:

deleteCMSContent in interface IDAO

Throws:

DAOException

addCMSComponent

public boolean addCMSComponent(PersistentCMSComponent persistentCMSComponent)
                        throws DAOException

Specified by:

addCMSComponent in interface IDAO

Throws:

DAOException

updatedCMSComponent

public boolean updatedCMSComponent(PersistentCMSComponent persistentCMSComponent)
                            throws DAOException

Specified by:

updatedCMSComponent in interface IDAO

Throws:

DAOException

getCMSComponent

public PersistentCMSComponent getCMSComponent(Long id)
                                       throws DAOException

Specified by:

getCMSComponent in interface IDAO

Throws:

DAOException

getAllCMSMediaItems

public List<CMSMediaItem> getAllCMSMediaItems()
                                       throws DAOException

getAllCMSMediaItems.

Specified by:

getAllCMSMediaItems in interface IDAO

Returns:

list of all CMS media items in the database

Throws:

DAOException - if any.

getAllCMSCollectionItems

public List<CMSMediaItem> getAllCMSCollectionItems()
                                            throws DAOException

getAllCMSCollectionItems.

Specified by:

getAllCMSCollectionItems in interface IDAO

Returns:

list of all CMS media items that represent collections

Throws:

DAOException - if any.

getCMSMediaItemByFilename

public CMSMediaItem getCMSMediaItemByFilename(String filename)
                                       throws DAOException

getCMSMediaItemByFilename.

Specified by:

getCMSMediaItemByFilename in interface IDAO

Parameters:

filename - filename of the CMS media item to look up

Returns:

the matching CMS media item, or null if not found

Throws:

DAOException - if any.

getCMSMediaItem

public CMSMediaItem getCMSMediaItem(long id)
                             throws DAOException

getCMSMediaItem.

Specified by:

getCMSMediaItem in interface IDAO

Parameters:

id - database primary key of the CMS media item

Returns:

the matching CMS media item, or null if not found

Throws:

DAOException - if any.

addCMSMediaItem

public boolean addCMSMediaItem(CMSMediaItem item)
                        throws DAOException

addCMSMediaItem.

Specified by:

addCMSMediaItem in interface IDAO

Parameters:

item - CMS media item to persist

Returns:

true if CMS media item was added successfully; false otherwise

Throws:

DAOException - if any.

updateCMSMediaItem

public boolean updateCMSMediaItem(CMSMediaItem item)
                           throws DAOException

updateCMSMediaItem.

Specified by:

updateCMSMediaItem in interface IDAO

Parameters:

item - CMS media item to update in the database

Returns:

true if CMS media item was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCMSMediaItem

public boolean deleteCMSMediaItem(CMSMediaItem item)
                           throws DAOException

deleteCMSMediaItem.

Specified by:

deleteCMSMediaItem in interface IDAO

Parameters:

item - CMS media item to delete from the database

Returns:

true if CMS media item was deleted successfully; false otherwise

Throws:

DAOException - if any.

getCMSMediaItemsByCategory

public List<CMSMediaItem> getCMSMediaItemsByCategory(CMSCategory category)
                                              throws DAOException

Gets a list of all CMSMediaItems which contain the given category.

Specified by:

getCMSMediaItemsByCategory in interface IDAO

Parameters:

category - category to filter media items by

Returns:

all containing cmsPages

Throws:

DAOException

getAllTopCMSNavigationItems

public List<CMSNavigationItem> getAllTopCMSNavigationItems()
                                                    throws DAOException

getAllTopCMSNavigationItems.

Specified by:

getAllTopCMSNavigationItems in interface IDAO

Returns:

list of all top-level CMS navigation items

Throws:

DAOException - if any.

getCMSNavigationItem

public CMSNavigationItem getCMSNavigationItem(long id)
                                       throws DAOException

getCMSNavigationItem.

Specified by:

getCMSNavigationItem in interface IDAO

Parameters:

id - database primary key of the navigation item

Returns:

the matching CMS navigation item, or null if not found

Throws:

DAOException - if any.

addCMSNavigationItem

public boolean addCMSNavigationItem(CMSNavigationItem item)
                             throws DAOException

addCMSNavigationItem.

Specified by:

addCMSNavigationItem in interface IDAO

Parameters:

item - CMS navigation item to persist

Returns:

true if navigation item was added successfully; false otherwise

Throws:

DAOException - if any.

updateCMSNavigationItem

public boolean updateCMSNavigationItem(CMSNavigationItem item)
                                throws DAOException

updateCMSNavigationItem.

Specified by:

updateCMSNavigationItem in interface IDAO

Parameters:

item - CMS navigation item to update in the database

Returns:

true if navigation item was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCMSNavigationItem

public boolean deleteCMSNavigationItem(CMSNavigationItem item)
                                throws DAOException

deleteCMSNavigationItem.

Specified by:

deleteCMSNavigationItem in interface IDAO

Parameters:

item - CMS navigation item to delete from the database

Returns:

true if navigation item was deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllTranskribusJobs

public List<TranskribusJob> getAllTranskribusJobs()
                                           throws DAOException

getAllTranskribusJobs.

Specified by:

getAllTranskribusJobs in interface IDAO

Returns:

list of all Transkribus jobs in the database

Throws:

DAOException - if any.

getTranskribusJobs

public List<TranskribusJob> getTranskribusJobs(String pi,
 String transkribusUserId,
 JobStatus status)
                                        throws DAOException

getTranskribusJobs.

Specified by:

getTranskribusJobs in interface IDAO

Parameters:

pi - persistent identifier of the record, or null to ignore

transkribusUserId - Transkribus user ID to filter by, or null to ignore

status - job status to filter by, or null to ignore

Returns:

list of Transkribus jobs matching the given filters

Throws:

DAOException - if any.

addTranskribusJob

public boolean addTranskribusJob(TranskribusJob job)
                          throws DAOException

addTranskribusJob.

Specified by:

addTranskribusJob in interface IDAO

Parameters:

job - Transkribus job to persist

Returns:

true if job added successfully; false otherwise

Throws:

DAOException - if any.

updateTranskribusJob

public boolean updateTranskribusJob(TranskribusJob job)
                             throws DAOException

updateTranskribusJob.

Specified by:

updateTranskribusJob in interface IDAO

Parameters:

job - Transkribus job to update in the database

Returns:

true if job updated successfully; false otherwise

Throws:

DAOException - if any.

deleteTranskribusJob

public boolean deleteTranskribusJob(TranskribusJob job)
                             throws DAOException

deleteTranskribusJob.

Specified by:

deleteTranskribusJob in interface IDAO

Parameters:

job - Transkribus job to delete from the database

Returns:

true if job deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllCampaigns

public List<Campaign> getAllCampaigns()
                               throws DAOException

getAllCampaigns.

Specified by:

getAllCampaigns in interface IDAO

Returns:

list of all crowdsourcing campaigns in the database

Throws:

DAOException - if any.

getCampaignCount

public long getCampaignCount(Map<String,String> filters)
                      throws DAOException

getCampaignCount.

Specified by:

getCampaignCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of crowdsourcing campaigns matching the given filters

Throws:

DAOException - if any.

getCampaigns

public List<Campaign> getCampaigns(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                            throws DAOException

getCampaigns.

Specified by:

getCampaigns in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of crowdsourcing campaigns matching the given criteria

Throws:

DAOException - if any.

getCampaign

public Campaign getCampaign(Long id)
                     throws DAOException

getCampaign.

Specified by:

getCampaign in interface IDAO

Parameters:

id - database primary key of the campaign

Returns:

the matching campaign, or null if not found

Throws:

DAOException - if any.

getQuestion

public Question getQuestion(Long id)
                     throws DAOException

getQuestion.

Specified by:

getQuestion in interface IDAO

Parameters:

id - database primary key of the question

Returns:

the matching campaign question, or null if not found

Throws:

DAOException - if any.

getCampaignStatisticsForRecord

public List<CampaignRecordStatistic> getCampaignStatisticsForRecord(String pi,
 CrowdsourcingStatus status)
                                                             throws DAOException

getCampaignStatisticsForRecord.

Specified by:

getCampaignStatisticsForRecord in interface IDAO

Parameters:

pi - persistent identifier of the record

status - crowdsourcing status to filter by, or null for any status

Returns:

list of campaign record statistics for the given record

Throws:

DAOException - if any.

getCampaignPageStatisticsForRecord

public List<CampaignRecordPageStatistic> getCampaignPageStatisticsForRecord(String pi,
 CrowdsourcingStatus status)
                                                                     throws DAOException

getCampaignPageStatisticsForRecord.

Specified by:

getCampaignPageStatisticsForRecord in interface IDAO

Parameters:

pi - persistent identifier of the record

status - crowdsourcing status to filter by, or null for any status

Returns:

list of campaign page statistics for the given record

Throws:

DAOException - if any.

addCampaign

public boolean addCampaign(Campaign campaign)
                    throws DAOException

addCampaign.

Specified by:

addCampaign in interface IDAO

Parameters:

campaign - crowdsourcing campaign to persist

Returns:

true if campaign added successfully; false otherwise

Throws:

DAOException - if any.

updateCampaign

public boolean updateCampaign(Campaign campaign)
                       throws DAOException

updateCampaign.

Specified by:

updateCampaign in interface IDAO

Parameters:

campaign - crowdsourcing campaign to update in the database

Returns:

true if campaign updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCampaign

public boolean deleteCampaign(Campaign campaign)
                       throws DAOException

deleteCampaign.

Specified by:

deleteCampaign in interface IDAO

Parameters:

campaign - crowdsourcing campaign to delete from the database

Returns:

true if campaign deleted successfully; false otherwise

Throws:

DAOException - if any.

deleteCampaignStatisticsForUser

public int deleteCampaignStatisticsForUser(User user)
                                    throws DAOException

Description copied from interface: IDAO

Deletes given user from the lists of annotators and reviewers an all campaign statistics.

Specified by:

deleteCampaignStatisticsForUser in interface IDAO

Parameters:

user - the user whose campaign statistics entries are deleted

Returns:

the total number of database rows deleted across all statistic tables

Throws:

DAOException

See Also:

• IDAO.deleteCampaignStatisticsForUser(io.goobi.viewer.model.security.user.User)

changeCampaignStatisticContributors

public int changeCampaignStatisticContributors(User fromUser,
 User toUser)
                                        throws DAOException

Description copied from interface: IDAO

Replaced fromUser with toUser in the lists of annotators and reviewers an all campaign statistics.

Specified by:

changeCampaignStatisticContributors in interface IDAO

Parameters:

fromUser - the user whose campaign statistic entries are replaced

toUser - the user who replaces fromUser in all campaign statistic entries

Returns:

the total number of database rows updated across all statistic tables

Throws:

DAOException - if a database error occurs

See Also:

• IDAO.changeCampaignStatisticContributors(io.goobi.viewer.model.security.user.User, io.goobi.viewer.model.security.user.User)

checkAvailability

public boolean checkAvailability()

Specified by:

checkAvailability in interface IDAO

Returns:

true if accessible; false otherwise

clear

public void clear()

Currently noop since no persistence entity manager is kept.

shutdown

public void shutdown()

shutdown.

Specified by:

shutdown in interface IDAO

preQuery

public void preQuery()
              throws DAOException

Operation to call before getting an entity manager. currently noop

Throws:

DAOException - if any.

getUserGroupCount

public long getUserGroupCount(Map<String,String> filters)
                       throws DAOException

getUserGroupCount.

Specified by:

getUserGroupCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of user groups matching the given filters

Throws:

DAOException - if any.

getRoleCount

public long getRoleCount(Map<String,String> filters)
                  throws DAOException

getRoleCount.

Specified by:

getRoleCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of roles matching the given filters

Throws:

DAOException - if any.

getLicenseTypeCount

public long getLicenseTypeCount(Map<String,String> filters)
                         throws DAOException

getLicenseTypeCount.

Specified by:

getLicenseTypeCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of license types matching the given filters

Throws:

DAOException - if any.

getCoreLicenseTypeCount

public long getCoreLicenseTypeCount(Map<String,String> filters)
                             throws DAOException

getCoreLicenseTypeCount.

Specified by:

getCoreLicenseTypeCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of core license types matching the given filters

Throws:

DAOException - if any.

getIpRangeCount

public long getIpRangeCount(Map<String,String> filters)
                     throws DAOException

getIpRangeCount.

Specified by:

getIpRangeCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of IP ranges matching the given filters

Throws:

DAOException - if any.

getCommentCount

public long getCommentCount(Map<String,String> filters,
 User owner,
 Set<String> targetPIs)
                     throws DAOException

getCommentCount.

Specified by:

getCommentCount in interface IDAO

Parameters:

filters - map of field names to filter values

owner - user who owns the comments, or null for all users

targetPIs - set of persistent identifiers to restrict results to

Returns:

Number of rows that match the criteria

Throws:

DAOException - if any.

getCMSPageCount

public long getCMSPageCount(Map<String,String> filters,
 List<Long> allowedTemplates,
 List<String> allowedSubthemes,
 List<String> allowedCategories)
                     throws DAOException

getCMSPageCount.

Specified by:

getCMSPageCount in interface IDAO

Parameters:

filters - map of field names to filter values

allowedTemplates - list of template IDs the user is allowed to see

allowedSubthemes - list of subtheme identifiers the user is allowed to see

allowedCategories - list of category names the user is allowed to see

Returns:

total number of CMS pages matching the given filters and permissions

Throws:

DAOException - if any.

getCMSPageCountByPropertyValue

public long getCMSPageCountByPropertyValue(String propertyName,
 String propertyValue)
                                    throws DAOException

Specified by:

getCMSPageCountByPropertyValue in interface IDAO

Parameters:

propertyName - name of the CMS page property to filter by

propertyValue - value of the CMS page property to filter by

Returns:

long

Throws:

DAOException - if a database error occurs

getCMSPagesByPropertyValue

public List<CMSPage> getCMSPagesByPropertyValue(String propertyName,
 String propertyValue)
                                         throws DAOException

Specified by:

getCMSPagesByPropertyValue in interface IDAO

Parameters:

propertyName - name of the CMS page property to filter by

propertyValue - value of the CMS page property to filter by

Returns:

List

Throws:

DAOException - if a database error occurs

getAllStaticPages

public List<CMSStaticPage> getAllStaticPages()
                                      throws DAOException

getAllStaticPages.

Specified by:

getAllStaticPages in interface IDAO

Returns:

list of all CMS static page mappings in the database

Throws:

DAOException - if any.

addStaticPage

public boolean addStaticPage(CMSStaticPage page)
                      throws DAOException

addStaticPage.

Specified by:

addStaticPage in interface IDAO

Parameters:

page - static page to persist

Returns:

true if page added successfully; false otherwise

Throws:

DAOException - if any.

updateStaticPage

public boolean updateStaticPage(CMSStaticPage page)
                         throws DAOException

updateStaticPage.

Specified by:

updateStaticPage in interface IDAO

Parameters:

page - static page to update in the database

Returns:

true if page updated successfully; false otherwise

Throws:

DAOException - if any.

deleteStaticPage

public boolean deleteStaticPage(CMSStaticPage page)
                         throws DAOException

deleteStaticPage.

Specified by:

deleteStaticPage in interface IDAO

Parameters:

page - static page to delete from the database

Returns:

true if page deleted successfully; false otherwise

Throws:

DAOException - if any.

getStaticPageForCMSPage

public List<CMSStaticPage> getStaticPageForCMSPage(CMSPage page)
                                            throws DAOException,
NonUniqueResultException

getStaticPageForCMSPage.

Specified by:

getStaticPageForCMSPage in interface IDAO

Parameters:

page - CMS page whose static page mappings to retrieve

Returns:

list of static page mappings associated with the given CMS page

Throws:

DAOException - if any.

NonUniqueResultException

getStaticPageForTypeType

public Optional<CMSStaticPage> getStaticPageForTypeType(PageType pageType)
                                                 throws DAOException

getStaticPageForTypeType.

Specified by:

getStaticPageForTypeType in interface IDAO

Parameters:

pageType - viewer page type to look up the static page mapping for

Returns:

the CMS static page mapped to the given page type, or empty if none exists

Throws:

DAOException - if any.

getCmsArchiveConfigForArchive

public Optional<CMSArchiveConfig> getCmsArchiveConfigForArchive(String pi)
                                                         throws DAOException

Specified by:

getCmsArchiveConfigForArchive in interface IDAO

Parameters:

pi - Archive record identifier

Returns:

Optional for the given pi; null if none found

Throws:

DAOException

getCMSArchiveConfigs

public List<CMSArchiveConfig> getCMSArchiveConfigs(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                            throws DAOException

getCMSArchiveConfigs.

Specified by:

getCMSArchiveConfigs in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of column filter values

Returns:

List

Throws:

DAOException - if any.

getCMSArchiveConfigCount

public long getCMSArchiveConfigCount(Map<String,String> filters)
                              throws DAOException

getCMSArchiveConfigCount.

Specified by:

getCMSArchiveConfigCount in interface IDAO

Parameters:

filters - Selected filters

Returns:

Number of found rows

Throws:

DAOException - if any.

saveCMSArchiveConfig

public boolean saveCMSArchiveConfig(CMSArchiveConfig config)
                             throws DAOException

saveCMSArchiveConfig.

Specified by:

saveCMSArchiveConfig in interface IDAO

Parameters:

config - CMS archive configuration to persist or update

Returns:

true if archive config was saved successfully; false otherwise

Throws:

DAOException - if any.

deleteCMSArchiveConfig

public boolean deleteCMSArchiveConfig(CMSArchiveConfig config)
                               throws DAOException

deleteCMSArchiveConfig.

Specified by:

deleteCMSArchiveConfig in interface IDAO

Parameters:

config - CMS archive configuration to delete from the database

Returns:

true if archive config was deleted successfully; false otherwise

Throws:

DAOException - if any.

getCMSCollections

public List<CMSCollection> getCMSCollections(String solrField)
                                      throws DAOException

getCMSCollections.

Specified by:

getCMSCollections in interface IDAO

Parameters:

solrField - Solr field name identifying the collection type

Returns:

list of CMS collections for the given Solr field

Throws:

DAOException - if any.

addCMSCollection

public boolean addCMSCollection(CMSCollection collection)
                         throws DAOException

addCMSCollection.

Specified by:

addCMSCollection in interface IDAO

Parameters:

collection - CMS collection to persist

Returns:

true if CMS collection was added successfully; false otherwise

Throws:

DAOException - if any.

updateCMSCollection

public boolean updateCMSCollection(CMSCollection collection)
                            throws DAOException

updateCMSCollection.

Specified by:

updateCMSCollection in interface IDAO

Parameters:

collection - CMS collection to update in the database

Returns:

true if CMS collection was updated successfully; false otherwise

Throws:

DAOException - if any.

getCMSCollection

public CMSCollection getCMSCollection(String solrField,
 String solrFieldValue)
                               throws DAOException

getCMSCollection.

Specified by:

getCMSCollection in interface IDAO

Parameters:

solrField - Solr field name identifying the collection type

solrFieldValue - Solr field value identifying the collection

Returns:

the matching CMS collection, or null if not found

Throws:

DAOException - if any.

deleteCMSCollection

public boolean deleteCMSCollection(CMSCollection collection)
                            throws DAOException

deleteCMSCollection.

Specified by:

deleteCMSCollection in interface IDAO

Parameters:

collection - CMS collection to delete from the database

Returns:

true if CMS collection was deleted successfully; false otherwise

Throws:

DAOException - if any.

getCMSPagesByCategory

public List<CMSPage> getCMSPagesByCategory(CMSCategory category)
                                    throws DAOException

getCMSPagesByCategory.

Specified by:

getCMSPagesByCategory in interface IDAO

Parameters:

category - category to filter CMS pages by

Returns:

list of CMS pages that have the given category assigned

Throws:

DAOException - if any.

getCMSPagesForSubtheme

public List<CMSPage> getCMSPagesForSubtheme(String subtheme)
                                     throws DAOException

Specified by:

getCMSPagesForSubtheme in interface IDAO

Parameters:

subtheme - subtheme identifier to filter CMS pages by

Returns:

List of CMSPages that use given subtheme

Throws:

DAOException

getCMSPagesForRecord

public List<CMSPage> getCMSPagesForRecord(String pi,
 CMSCategory category)
                                   throws DAOException

getCMSPagesForRecord.

Specified by:

getCMSPagesForRecord in interface IDAO

Parameters:

pi - persistent identifier of the record

category - category to filter CMS pages by, or null for all categories

Returns:

list of CMS pages associated with the given record

Throws:

DAOException - if any.

createCMSPageFilter

public static String createCMSPageFilter(Map<String,Object> params,
 String pageParameter,
 List<Long> allowedTemplates,
 List<String> allowedSubthemes,
 List<String> allowedCategoryIds)
                                  throws AccessDeniedException

createCMSPageFilter.

Parameters:

params - query parameter map to populate with named parameter values

pageParameter - JPQL alias for the CMS page entity in the query

allowedTemplates - template IDs the user may view; null means no restriction

allowedSubthemes - subtheme discriminator values the user may view; null means no restriction

allowedCategoryIds - category IDs the user may view; null means no restriction

Returns:

the JPQL WHERE clause fragment restricting CMS page visibility, possibly empty

Throws:

AccessDeniedException - if any.

getAllCategories

public List<CMSCategory> getAllCategories()
                                   throws DAOException

getAllCategories.

Specified by:

getAllCategories in interface IDAO

Returns:

list of all CMS categories in the database

Throws:

DAOException - if any.

getCountPagesUsingCategory

public long getCountPagesUsingCategory(CMSCategory category)
                                throws DAOException

Specified by:

getCountPagesUsingCategory in interface IDAO

Parameters:

category - category to count CMS pages for

Returns:

Number of existing CMS pages having the given category

Throws:

DAOException

getCountMediaItemsUsingCategory

public long getCountMediaItemsUsingCategory(CMSCategory category)
                                     throws DAOException

Specified by:

getCountMediaItemsUsingCategory in interface IDAO

Parameters:

category - category to count CMS media items for

Returns:

Number of existing CMS media items having the given category

Throws:

DAOException

addCategory

public boolean addCategory(CMSCategory category)
                    throws DAOException

addCategory.

Persist a new CMSCategory object

Specified by:

addCategory in interface IDAO

Parameters:

category - CMS category to persist

Returns:

true if category added successfully; false otherwise

Throws:

DAOException - if any.

updateCategory

public boolean updateCategory(CMSCategory category)
                       throws DAOException

updateCategory.

Update an existing CMSCategory object in the persistence context

Specified by:

updateCategory in interface IDAO

Parameters:

category - CMS category to update in the database

Returns:

true if category updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCategory

public boolean deleteCategory(CMSCategory category)
                       throws DAOException

deleteCategory.

Delete a CMSCategory object from the persistence context

Specified by:

deleteCategory in interface IDAO

Parameters:

category - CMS category to delete from the database

Returns:

true if category deleted successfully; false otherwise

Throws:

DAOException - if any.

getCategoryByName

public CMSCategory getCategoryByName(String name)
                              throws DAOException

getCategoryByName.

Search the persistence context for a CMSCategory with the given name.

Specified by:

getCategoryByName in interface IDAO

Parameters:

name - name of the category to look up

Returns:

the matching CMS category, or null if not found

Throws:

DAOException - if any.

getCategory

public CMSCategory getCategory(Long id)
                        throws DAOException

getCategory.

Search the persistence context for a CMSCategory with the given unique id.

Specified by:

getCategory in interface IDAO

Parameters:

id - database primary key of the category

Returns:

the matching CMS category, or null if not found

Throws:

DAOException - if any.

tableExists

public boolean tableExists(String tableName)
                    throws DAOException,
SQLException

tableExists.

Check if the database contains a table of the given name. Used by backward-compatibility routines

Specified by:

tableExists in interface IDAO

Parameters:

tableName - name of the database table to check

Returns:

true if the table exists; false otherwise

Throws:

SQLException

DAOException

columnsExists

public boolean columnsExists(String tableName,
 String columnName)
                      throws SQLException,
DAOException

columnsExists.

Check if the database contains a column in a table with the given names. Used by backward-compatibility routines

Specified by:

columnsExists in interface IDAO

Parameters:

tableName - name of the database table to check

columnName - name of the column to check for existence

Returns:

true if the column exists in the table; false otherwise

Throws:

SQLException - if any.

DAOException

getAnnotation

public CrowdsourcingAnnotation getAnnotation(Long id)
                                      throws DAOException

Annotations *.

Specified by:

getAnnotation in interface IDAO

Parameters:

id - database primary key of the annotation

Returns:

the matching crowdsourcing annotation, or null if not found

Throws:

DAOException - if any.

getAnnotationsForCampaign

public List<CrowdsourcingAnnotation> getAnnotationsForCampaign(Campaign campaign)
                                                        throws DAOException

getAnnotationsForCampaign.

Specified by:

getAnnotationsForCampaign in interface IDAO

Parameters:

campaign - campaign whose annotations to retrieve

Returns:

list of crowdsourcing annotations for the given campaign

Throws:

DAOException - if any.

getAnnotationsForWork

public List<CrowdsourcingAnnotation> getAnnotationsForWork(String pi)
                                                    throws DAOException

getAnnotationsForWork.

Get all annotations associated with the work of the given pi

Specified by:

getAnnotationsForWork in interface IDAO

Parameters:

pi - persistent identifier of the record

Returns:

list of crowdsourcing annotations for the given record

Throws:

DAOException - if any.

getAllAnnotations

public List<CrowdsourcingAnnotation> getAllAnnotations(String sortField,
 boolean descending)
                                                throws DAOException

Specified by:

getAllAnnotations in interface IDAO

Parameters:

sortField - field to sort by

descending - true for descending sort order

Returns:

List of all existing CrowdsourcingAnnotations, optionally sorted by given sortField

Throws:

DAOException

getTotalAnnotationCount

public long getTotalAnnotationCount()
                             throws DAOException

Specified by:

getTotalAnnotationCount in interface IDAO

Returns:

Number of all existing CrowdsourcingAnnotations

Throws:

DAOException

getAllAnnotationsByMotivation

public List<CrowdsourcingAnnotation> getAllAnnotationsByMotivation(String motivation)
                                                            throws DAOException

Specified by:

getAllAnnotationsByMotivation in interface IDAO

Parameters:

motivation - annotation motivation value to filter by

Returns:

List of CrowdsourcingAnnotations matching given commenting

Throws:

DAOException

getAnnotationCountForWork

public long getAnnotationCountForWork(String pi)
                               throws DAOException

Specified by:

getAnnotationCountForWork in interface IDAO

Parameters:

pi - persistent identifier of the record

Returns:

Number of existing annotations for the given pi

Throws:

DAOException

getAnnotationsForTarget

public List<CrowdsourcingAnnotation> getAnnotationsForTarget(String pi,
 Integer page)
                                                      throws DAOException

getAnnotationsForTarget.

Specified by:

getAnnotationsForTarget in interface IDAO

Parameters:

pi - persistent identifier of the record

page - page order number within the record, or null for all pages

Returns:

list of crowdsourcing annotations targeting the given record page

Throws:

DAOException - if any.

getAnnotationsForTarget

public List<CrowdsourcingAnnotation> getAnnotationsForTarget(String pi,
 Integer page,
 String motivation)
                                                      throws DAOException

Specified by:

getAnnotationsForTarget in interface IDAO

Throws:

DAOException

getAnnotationCountForTarget

public long getAnnotationCountForTarget(String pi,
 Integer page)
                                 throws DAOException

getAnnotationCountForTarget.

Specified by:

getAnnotationCountForTarget in interface IDAO

Parameters:

pi - persistent identifier of the record

page - page order number within the record, or null for all pages

Returns:

total number of crowdsourcing annotations for the given record page

Throws:

DAOException - if any.

getAnnotationsForCampaignAndWork

public List<CrowdsourcingAnnotation> getAnnotationsForCampaignAndWork(Campaign campaign,
 String pi)
                                                               throws DAOException

getAnnotationsForCampaignAndWork.

Specified by:

getAnnotationsForCampaignAndWork in interface IDAO

Parameters:

campaign - campaign whose annotations to retrieve

pi - persistent identifier of the record

Returns:

list of crowdsourcing annotations for the given campaign and record

Throws:

DAOException - if any.

getAnnotationsForCampaignAndTarget

public List<CrowdsourcingAnnotation> getAnnotationsForCampaignAndTarget(Campaign campaign,
 String pi,
 Integer page)
                                                                 throws DAOException

getAnnotationsForCampaignAndTarget.

Specified by:

getAnnotationsForCampaignAndTarget in interface IDAO

Parameters:

campaign - campaign whose annotations to retrieve

pi - persistent identifier of the record

page - page order number within the record, or null for all pages

Returns:

list of crowdsourcing annotations for the given campaign and record page

Throws:

DAOException - if any.

getAnnotationsForUserId

public List<CrowdsourcingAnnotation> getAnnotationsForUserId(Long userId,
 Integer maxResults,
 String sortField,
 boolean descending)
                                                      throws DAOException

Specified by:

getAnnotationsForUserId in interface IDAO

Parameters:

userId - database id of the annotation creator

maxResults - maximum number of results to return

sortField - field to sort by

descending - true for descending sort order

Returns:

List of CrowdsourcingAnnotations for the given userId

Throws:

DAOException

getAnnotations

public List<CrowdsourcingAnnotation> getAnnotations(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                             throws DAOException

getAnnotations.

Specified by:

getAnnotations in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of crowdsourcing annotations matching the given criteria

Throws:

DAOException - if any.

getAnnotations

public List<CrowdsourcingAnnotation> getAnnotations(int first,
 int pageSize,
 String sortField,
 boolean descending,
 String filterString,
 Map<String,Object> params)
                                             throws DAOException

Specified by:

getAnnotations in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filterString - JPQL WHERE clause fragment for additional filtering

params - named parameters for the filterString clause

Returns:

List of CrowdsourcingAnnotations matching given filters

Throws:

DAOException

getAnnotationCount

public long getAnnotationCount(Map<String,String> filters)
                        throws DAOException

getAnnotationCount.

Specified by:

getAnnotationCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of crowdsourcing annotations matching the given filters

Throws:

DAOException - if any.

addAnnotation

public boolean addAnnotation(CrowdsourcingAnnotation annotation)
                      throws DAOException

addAnnotation.

Specified by:

addAnnotation in interface IDAO

Parameters:

annotation - crowdsourcing annotation to persist

Returns:

true if annotation was added successfully; false otherwise

Throws:

DAOException - if any.

updateAnnotation

public boolean updateAnnotation(CrowdsourcingAnnotation annotation)
                         throws DAOException

updateAnnotation.

Specified by:

updateAnnotation in interface IDAO

Parameters:

annotation - crowdsourcing annotation to update in the database

Returns:

true if annotation was updated successfully; false otherwise

Throws:

DAOException - if any.

deleteAnnotation

public boolean deleteAnnotation(CrowdsourcingAnnotation annotation)
                         throws DAOException

deleteAnnotation.

Specified by:

deleteAnnotation in interface IDAO

Parameters:

annotation - crowdsourcing annotation to delete from the database

Returns:

true if annotation was deleted successfully; false otherwise

Throws:

DAOException - if any.

getGeoMap

public GeoMap getGeoMap(Long mapId)
                 throws DAOException

Gets the GeoMap of the given mapId.

Specified by:

getGeoMap in interface IDAO

Parameters:

mapId - database id of the geo map

Returns:

The GeoMap of the given id or else null

Throws:

DAOException - if a database error occurs

getAllGeoMaps

public List<GeoMap> getAllGeoMaps()
                           throws DAOException

Gets all GeoMaps in database.

Specified by:

getAllGeoMaps in interface IDAO

Returns:

A list of all stored GeoMaps

Throws:

DAOException

addGeoMap

public boolean addGeoMap(GeoMap map)
                  throws DAOException

Adds the given map to the database if no map of the same id already exists.

Specified by:

addGeoMap in interface IDAO

Parameters:

map - geo map to add

Returns:

true if successful

Throws:

DAOException

updateGeoMap

public boolean updateGeoMap(GeoMap map)
                     throws DAOException

Updates the given GeoMap in the database.

Specified by:

updateGeoMap in interface IDAO

Parameters:

map - geo map to update

Returns:

true if successful

Throws:

DAOException

deleteGeoMap

public boolean deleteGeoMap(GeoMap map)
                     throws DAOException

Deletes the given GeoMap from the database.

Specified by:

deleteGeoMap in interface IDAO

Parameters:

map - geo map to delete

Returns:

true if successful

Throws:

DAOException

getPagesUsingMap

public List<CMSPage> getPagesUsingMap(GeoMap map)
                               throws DAOException

Returns a list of CMS-pages embedding the given map.

Specified by:

getPagesUsingMap in interface IDAO

Parameters:

map - geo map to find embedding pages for

Returns:

List of CMSPages that use given map

Throws:

DAOException

getPagesUsingMapInSidebar

public List<CMSPage> getPagesUsingMapInSidebar(GeoMap map)
                                        throws DAOException

Returns a list of CMS-pages embedding the given map in a sidebar widget.

Specified by:

getPagesUsingMapInSidebar in interface IDAO

Parameters:

map - geo map to find embedding sidebar pages for

Returns:

List of CMSPages that use given map in sidebar

Throws:

DAOException

saveTermsOfUse

public boolean saveTermsOfUse(TermsOfUse tou)
                       throws DAOException

Specified by:

saveTermsOfUse in interface IDAO

Throws:

DAOException

getTermsOfUse

public TermsOfUse getTermsOfUse()
                         throws DAOException

Specified by:

getTermsOfUse in interface IDAO

Throws:

DAOException

resetUserAgreementsToTermsOfUse

public boolean resetUserAgreementsToTermsOfUse()
                                        throws DAOException

Specified by:

resetUserAgreementsToTermsOfUse in interface IDAO

Throws:

DAOException

getRecordNotes

public List<CMSRecordNote> getRecordNotes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                   throws DAOException

Gets a paginated list of CMSRecordNotes.

Specified by:

getRecordNotes in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of column filter values

Returns:

List of CMSPages that match the given filters

Throws:

DAOException

getAllRecordNotes

public List<CMSRecordNote> getAllRecordNotes()
                                      throws DAOException

Gets all persisted CMSRecordNotes.

Specified by:

getAllRecordNotes in interface IDAO

Returns:

List of all existing CMSSingleRecordNotes

Throws:

DAOException

getRecordNotesForPi

public List<CMSSingleRecordNote> getRecordNotesForPi(String pi,
 boolean displayedNotesOnly)
                                              throws DAOException

Gets all CMSRecordNotes for the given pi.

Specified by:

getRecordNotesForPi in interface IDAO

Parameters:

pi - The pi of the record.

displayedNotesOnly - set to true to only return notes with CMSRecordNote.isDisplayNote() set to true

Returns:

List of CMSSingleRecordNotes for the given pi

Throws:

DAOException

getAllMultiRecordNotes

public List<CMSMultiRecordNote> getAllMultiRecordNotes(boolean displayedNotesOnly)
                                                throws DAOException

Get all CMSMultiRecordNotes. To find notes relating to record, all notes must be check for matching query

Specified by:

getAllMultiRecordNotes in interface IDAO

Parameters:

displayedNotesOnly - if true, only return notes marked as displayed

Returns:

List of all existing CMSSingleRecordNotes, optionaly filtered by displayed only

Throws:

DAOException

getRecordNote

public CMSRecordNote getRecordNote(Long id)
                            throws DAOException

Gets a CMSRecordNote by its id property.

Specified by:

getRecordNote in interface IDAO

Parameters:

id - database id of the record note

Returns:

CMSSingleRecordNote with the given id

Throws:

DAOException - if a database error occurs

addRecordNote

public boolean addRecordNote(CMSRecordNote note)
                      throws DAOException

Persist a new CMSRecordNote.

Specified by:

addRecordNote in interface IDAO

Parameters:

note - record note to add

Returns:

true if note added successfully; false otherwise

Throws:

DAOException - if a database error occurs

updateRecordNote

public boolean updateRecordNote(CMSRecordNote note)
                         throws DAOException

Updates an existing CMSRecordNote.

Specified by:

updateRecordNote in interface IDAO

Parameters:

note - record note to update

Returns:

true if note updated successfully; false otherwise

Throws:

DAOException - if a database error occurs

deleteRecordNote

public boolean deleteRecordNote(CMSRecordNote note)
                         throws DAOException

Deletes an existing CMSRecordNote.

Specified by:

deleteRecordNote in interface IDAO

Parameters:

note - record note to delete

Returns:

true if note deleted successfully; false otherwise

Throws:

DAOException - if a database error occurs

getAllSliders

public List<CMSSlider> getAllSliders()
                              throws DAOException

Specified by:

getAllSliders in interface IDAO

Throws:

DAOException

getSlider

public CMSSlider getSlider(Long id)
                    throws DAOException

Specified by:

getSlider in interface IDAO

Throws:

DAOException

addSlider

public boolean addSlider(CMSSlider slider)
                  throws DAOException

Specified by:

addSlider in interface IDAO

Throws:

DAOException

updateSlider

public boolean updateSlider(CMSSlider slider)
                     throws DAOException

Specified by:

updateSlider in interface IDAO

Throws:

DAOException

deleteSlider

public boolean deleteSlider(CMSSlider slider)
                     throws DAOException

Specified by:

deleteSlider in interface IDAO

Throws:

DAOException

getPagesUsingSlider

public List<CMSPage> getPagesUsingSlider(CMSSlider slider)
                                  throws DAOException

Specified by:

getPagesUsingSlider in interface IDAO

Throws:

DAOException

getConfiguredThemes

public List<ThemeConfiguration> getConfiguredThemes()
                                             throws DAOException

Specified by:

getConfiguredThemes in interface IDAO

Throws:

DAOException

getTheme

public ThemeConfiguration getTheme(String name)
                            throws DAOException

Specified by:

getTheme in interface IDAO

Throws:

DAOException

addTheme

public boolean addTheme(ThemeConfiguration theme)
                 throws DAOException

Specified by:

addTheme in interface IDAO

Throws:

DAOException

updateTheme

public boolean updateTheme(ThemeConfiguration theme)
                    throws DAOException

Specified by:

updateTheme in interface IDAO

Throws:

DAOException

deleteTheme

public boolean deleteTheme(ThemeConfiguration theme)
                    throws DAOException

Specified by:

deleteTheme in interface IDAO

Throws:

DAOException

getAllCustomWidgets

public List<CustomSidebarWidget> getAllCustomWidgets()
                                              throws DAOException

Specified by:

getAllCustomWidgets in interface IDAO

Throws:

DAOException

getCustomWidget

public CustomSidebarWidget getCustomWidget(Long id)
                                    throws DAOException

Specified by:

getCustomWidget in interface IDAO

Throws:

DAOException

addCustomWidget

public boolean addCustomWidget(CustomSidebarWidget widget)
                        throws DAOException

Specified by:

addCustomWidget in interface IDAO

Throws:

DAOException

updateCustomWidget

public boolean updateCustomWidget(CustomSidebarWidget widget)
                           throws DAOException

Specified by:

updateCustomWidget in interface IDAO

Throws:

DAOException

deleteCustomWidget

public boolean deleteCustomWidget(Long id)
                           throws DAOException

Specified by:

deleteCustomWidget in interface IDAO

Throws:

DAOException

getPagesUsingWidget

public List<CMSPage> getPagesUsingWidget(CustomSidebarWidget widget)
                                  throws DAOException

Specified by:

getPagesUsingWidget in interface IDAO

Throws:

DAOException

getCookieBanner

public CookieBanner getCookieBanner()
                             throws DAOException

Specified by:

getCookieBanner in interface IDAO

Throws:

DAOException

saveCookieBanner

public boolean saveCookieBanner(CookieBanner banner)
                         throws DAOException

Specified by:

saveCookieBanner in interface IDAO

Throws:

DAOException

saveDisclaimer

public boolean saveDisclaimer(Disclaimer disclaimer)
                       throws DAOException

Specified by:

saveDisclaimer in interface IDAO

Throws:

DAOException

getDisclaimer

public Disclaimer getDisclaimer()
                         throws DAOException

Get the single stored Disclaimer. May return null if no disclaimer has been persisted yet

Specified by:

getDisclaimer in interface IDAO

Returns:

the disclaimer or null

Throws:

DAOException

getNumRecordsWithComments

public Long getNumRecordsWithComments(User user)
                               throws DAOException

Specified by:

getNumRecordsWithComments in interface IDAO

Throws:

DAOException

getNativeQueryResults

public List getNativeQueryResults(String query)
                           throws DAOException

Specified by:

getNativeQueryResults in interface IDAO

Throws:

DAOException

executeUpdate

public int executeUpdate(String query)
                  throws DAOException

Specified by:

executeUpdate in interface IDAO

Throws:

DAOException

getAllClientApplications

public List<ClientApplication> getAllClientApplications()
                                                 throws DAOException

Specified by:

getAllClientApplications in interface IDAO

Throws:

DAOException

getClientApplication

public ClientApplication getClientApplication(long id)
                                       throws DAOException

Specified by:

getClientApplication in interface IDAO

Throws:

DAOException

getClientApplicationByClientId

public ClientApplication getClientApplicationByClientId(String clientId)
                                                 throws DAOException

Specified by:

getClientApplicationByClientId in interface IDAO

Throws:

DAOException

saveClientApplication

public boolean saveClientApplication(ClientApplication client)
                              throws DAOException

Specified by:

saveClientApplication in interface IDAO

Throws:

DAOException

deleteClientApplication

public boolean deleteClientApplication(long id)
                                throws DAOException

Specified by:

deleteClientApplication in interface IDAO

Throws:

DAOException

getAllUsageStatistics

public List<DailySessionUsageStatistics> getAllUsageStatistics()
                                                        throws DAOException

Specified by:

getAllUsageStatistics in interface IDAO

Throws:

DAOException

getUsageStatistics

public DailySessionUsageStatistics getUsageStatistics(LocalDate date)
                                               throws DAOException

Specified by:

getUsageStatistics in interface IDAO

Throws:

DAOException

getUsageStatistics

public List<DailySessionUsageStatistics> getUsageStatistics(LocalDate start,
 LocalDate end)
                                                     throws DAOException

Specified by:

getUsageStatistics in interface IDAO

Throws:

DAOException

addUsageStatistics

public boolean addUsageStatistics(DailySessionUsageStatistics statistics)
                           throws DAOException

Specified by:

addUsageStatistics in interface IDAO

Throws:

DAOException

updateUsageStatistics

public boolean updateUsageStatistics(DailySessionUsageStatistics statistics)
                              throws DAOException

Specified by:

updateUsageStatistics in interface IDAO

Throws:

DAOException

deleteUsageStatistics

public boolean deleteUsageStatistics(long id)
                              throws DAOException

Specified by:

deleteUsageStatistics in interface IDAO

Throws:

DAOException

getAllCMSPageTemplates

public List<CMSPageTemplate> getAllCMSPageTemplates()
                                             throws DAOException

Specified by:

getAllCMSPageTemplates in interface IDAO

Throws:

DAOException

getCMSPageTemplate

public CMSPageTemplate getCMSPageTemplate(Long id)
                                   throws DAOException

Specified by:

getCMSPageTemplate in interface IDAO

Throws:

DAOException

addCMSPageTemplate

public boolean addCMSPageTemplate(CMSPageTemplate template)
                           throws DAOException

Specified by:

addCMSPageTemplate in interface IDAO

Throws:

DAOException

updateCMSPageTemplate

public boolean updateCMSPageTemplate(CMSPageTemplate template)
                              throws DAOException

Specified by:

updateCMSPageTemplate in interface IDAO

Throws:

DAOException

removeCMSPageTemplate

public boolean removeCMSPageTemplate(CMSPageTemplate template)
                              throws DAOException

Specified by:

removeCMSPageTemplate in interface IDAO

Throws:

DAOException

addViewerMessage

public boolean addViewerMessage(ViewerMessage message)
                         throws DAOException

Specified by:

addViewerMessage in interface IDAO

Throws:

DAOException

deleteViewerMessage

public boolean deleteViewerMessage(ViewerMessage message)
                            throws DAOException

Specified by:

deleteViewerMessage in interface IDAO

Throws:

DAOException

getViewerMessage

public ViewerMessage getViewerMessage(Long id)
                               throws DAOException

Specified by:

getViewerMessage in interface IDAO

Throws:

DAOException

updateViewerMessage

public boolean updateViewerMessage(ViewerMessage message)
                            throws DAOException

Specified by:

updateViewerMessage in interface IDAO

Throws:

DAOException

getViewerMessageByMessageID

public ViewerMessage getViewerMessageByMessageID(String messageId)
                                          throws DAOException

Specified by:

getViewerMessageByMessageID in interface IDAO

Throws:

DAOException

deleteViewerMessagesBefore

public int deleteViewerMessagesBefore(LocalDateTime date)
                               throws DAOException

Specified by:

deleteViewerMessagesBefore in interface IDAO

Throws:

DAOException

getViewerMessages

public List<ViewerMessage> getViewerMessages(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                      throws DAOException

Description copied from interface: IDAO

getViewerMessages.

Specified by:

getViewerMessages in interface IDAO

Parameters:

first - index of first result (pagination)

pageSize - max number of results to return

sortField - field to sort by

descending - true for descending sort order

filters - map of field names to filter values

Returns:

list of viewer messages matching the given criteria

Throws:

DAOException - if any.

getViewerMessageCount

public long getViewerMessageCount(Map<String,String> filters)
                           throws DAOException

getViewerMessageCount.

Specified by:

getViewerMessageCount in interface IDAO

Parameters:

filters - map of field names to filter values

Returns:

total number of viewer messages matching the given filters

Throws:

DAOException - if any.

getRecurringTaskTriggers

public List<RecurringTaskTrigger> getRecurringTaskTriggers()
                                                    throws DAOException

Specified by:

getRecurringTaskTriggers in interface IDAO

Throws:

DAOException

getRecurringTaskTrigger

public RecurringTaskTrigger getRecurringTaskTrigger(Long id)
                                             throws DAOException

Specified by:

getRecurringTaskTrigger in interface IDAO

Throws:

DAOException

getRecurringTaskTriggerForTask

public RecurringTaskTrigger getRecurringTaskTriggerForTask(ITaskType task)
                                                    throws DAOException

Specified by:

getRecurringTaskTriggerForTask in interface IDAO

Throws:

DAOException

addRecurringTaskTrigger

public boolean addRecurringTaskTrigger(RecurringTaskTrigger trigger)
                                throws DAOException

Specified by:

addRecurringTaskTrigger in interface IDAO

Throws:

DAOException

updateRecurringTaskTrigger

public boolean updateRecurringTaskTrigger(RecurringTaskTrigger trigger)
                                   throws DAOException

Specified by:

updateRecurringTaskTrigger in interface IDAO

Throws:

DAOException

deleteRecurringTaskTrigger

public boolean deleteRecurringTaskTrigger(Long id)
                                   throws DAOException

Specified by:

deleteRecurringTaskTrigger in interface IDAO

Throws:

DAOException

addHighlight

public boolean addHighlight(HighlightData object)
                     throws DAOException

Specified by:

addHighlight in interface IDAO

Throws:

DAOException

updateHighlight

public boolean updateHighlight(HighlightData object)
                        throws DAOException

Specified by:

updateHighlight in interface IDAO

Throws:

DAOException

deleteHighlight

public boolean deleteHighlight(Long id)
                        throws DAOException

Specified by:

deleteHighlight in interface IDAO

Throws:

DAOException

getHighlight

public HighlightData getHighlight(Long id)
                           throws DAOException

Specified by:

getHighlight in interface IDAO

Throws:

DAOException

getAllHighlights

public List<HighlightData> getAllHighlights()
                                     throws DAOException

Specified by:

getAllHighlights in interface IDAO

Throws:

DAOException

getHighlightsForDate

public List<HighlightData> getHighlightsForDate(LocalDateTime date)
                                         throws DAOException

Specified by:

getHighlightsForDate in interface IDAO

Throws:

DAOException

getPastHighlightsForDate

public List<HighlightData> getPastHighlightsForDate(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 LocalDateTime date)
                                             throws DAOException

Specified by:

getPastHighlightsForDate in interface IDAO

Throws:

DAOException

getFutureHighlightsForDate

public List<HighlightData> getFutureHighlightsForDate(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 LocalDateTime date)
                                               throws DAOException

Specified by:

getFutureHighlightsForDate in interface IDAO

Throws:

DAOException

getHighlights

public List<HighlightData> getHighlights(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                  throws DAOException

Specified by:

getHighlights in interface IDAO

Throws:

DAOException

getMaintenanceMode

public MaintenanceMode getMaintenanceMode()
                                   throws DAOException

Returns the only existing instance of MaintenanceMode.

Specified by:

getMaintenanceMode in interface IDAO

Returns:

the singleton MaintenanceMode entity, or null if not yet persisted

Throws:

DAOException - if any.

updateMaintenanceMode

public boolean updateMaintenanceMode(MaintenanceMode maintenanceMode)
                              throws DAOException

updateMaintenanceMode.

Specified by:

updateMaintenanceMode in interface IDAO

Parameters:

maintenanceMode - maintenance mode entity to update in the database

Returns:

true if maintenance mode was updated successfully; false otherwise

Throws:

DAOException - if any.