Coverage Summary for Class: BaseForm (org.kitodo.production.forms)

 /*
  * (c) Kitodo. Key to digital objects e. V. <contact@kitodo.org>
  *
  * This file is part of the Kitodo project.
  *
  * It is licensed under GNU General Public License version 3 or later.
  *
  * For the full copyright and license information, please read the
  * GPL3-License.txt file that was distributed with this source code.
  */
 
 package org.kitodo.production.forms;
 
 import java.io.Serializable;
 import java.text.DateFormat;
 import java.text.MessageFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.List;
 import java.util.Objects;
 
 import javax.faces.model.SelectItem;
 
 import org.kitodo.data.database.beans.Client;
 import org.kitodo.data.database.beans.ListColumn;
 import org.kitodo.data.database.beans.Project;
 import org.kitodo.data.database.beans.Role;
 import org.kitodo.data.database.beans.User;
 import org.kitodo.data.database.exceptions.DAOException;
 import org.kitodo.production.enums.ObjectType;
 import org.kitodo.production.helper.Helper;
 import org.kitodo.production.model.LazyDTOModel;
 import org.kitodo.production.services.ServiceManager;
 import org.kitodo.production.services.data.ClientService;
 import org.kitodo.production.services.data.ProjectService;
 import org.kitodo.production.services.data.RoleService;
 import org.primefaces.component.datatable.DataTable;
 import org.primefaces.event.TabChangeEvent;
 import org.primefaces.event.data.PageEvent;
 
 public class BaseForm implements Serializable {
 
     protected String stayOnCurrentPage = null;
     protected String filter = "";
     protected User user;
     protected LazyDTOModel lazyDTOModel = null;
     private static final String REDIRECT_PARAMETER = "faces-redirect=true";
     private static final String TEMPLATE_ROOT = "/pages/";
     private int activeTabIndex = 0;
     private int editActiveTabIndex = 0;
     private boolean saveDisabled = true;
 
     // error messages
     protected static final String ERROR_OCCURRED = "errorOccurred";
     protected static final String ERROR_DATABASE_READING = "errorDatabaseReading";
     protected static final String ERROR_DUPLICATE = "errorDuplicate";
     protected static final String ERROR_EXPORTING = "errorExporting";
     protected static final String ERROR_INCOMPLETE_DATA = "errorDataIncomplete";
     protected static final String ERROR_LOADING_MANY = "errorLoadingMany";
     protected static final String ERROR_LOADING_ONE = "errorLoadingOne";
     protected static final String ERROR_DELETING = "errorDeleting";
     public static final String ERROR_READING = "errorReading";
     protected static final String ERROR_RELOADING = "errorReloading";
     protected static final String ERROR_SAVING = "errorSaving";
     protected static final String ERROR_CREATING = "errorCreating";
     protected static final String ERROR_PARAMETER_MISSING = "parameterMissing";
     protected static final String EXPORT_FINISHED = "exportFinished";
 
     protected static final String REDIRECT_PATH = TEMPLATE_ROOT + "{0}?" + REDIRECT_PARAMETER;
     protected static final String DEFAULT_LINK = "desktop.jsf";
     private static final String LIST_PAGE = TEMPLATE_ROOT + "{0}?keepPagination=true&" + REDIRECT_PARAMETER;
     protected final String usersPage = MessageFormat.format(LIST_PAGE, "users");
     protected final String processesPage = "processes?" + REDIRECT_PARAMETER;
     protected final String projectsPage = MessageFormat.format(LIST_PAGE, "projects");
     protected final String tasksPage = MessageFormat.format(LIST_PAGE, "tasks");
 
     protected static final String ID_PARAMETER = "ID";
 
     protected List<SelectItem> columns;
     protected List<ListColumn> selectedColumns;
 
     protected int firstRow;
 
     /**
      * Get first row to show in datatable.
      * @return first
      */
     public int getFirstRow() {
         return this.firstRow;
     }
 
     /**
      * Set first row to show in datatable.
      * @param firstRow first row to show in datatable
      */
     public void setFirstRow(int firstRow) {
         this.firstRow = firstRow;
     }
 
     /**
      * Update first row to show in datatable on PageEvent.
      * @param pageEvent PageEvent triggered by data tables paginator
      */
     public void onPageChange(PageEvent pageEvent) {
         this.setFirstRow(((DataTable) pageEvent.getSource()).getFirst());
     }
 
     /**
      * Getter: return lazyDTOModel.
      *
      * @return LazyDTOModel
      */
     public LazyDTOModel getLazyDTOModel() {
         return lazyDTOModel;
     }
 
     /**
      * Setter: set lazyDTOModel.
      *
      * @param lazyDTOModel
      *            LazyDTOModel to set for this class
      */
     public void setLazyDTOModel(LazyDTOModel lazyDTOModel) {
         this.lazyDTOModel = lazyDTOModel;
     }
 
     /**
      * Get overlay for return null.
      *
      * @return to current page
      */
     public String getStayOnCurrentPage() {
         return this.stayOnCurrentPage;
     }
 
     /**
      * Set overlay for return null.
      *
      * @param stayOnCurrentPage
      *            overlay for return null which ensures staying on the same page
      *            where it was called
      */
     public void setStayOnCurrentPage(String stayOnCurrentPage) {
         this.stayOnCurrentPage = stayOnCurrentPage;
     }
 
     /**
      * Get User.
      *
      * @return User
      */
     public User getUser() {
         if (Objects.isNull(this.user)) {
             this.user = ServiceManager.getUserService().getCurrentUser();
         }
         return this.user;
     }
 
     public String getFilter() {
         return this.filter;
     }
 
     public void setFilter(String filter) {
         this.filter = filter;
     }
 
     /**
      * Add filter to user.
      */
     public void addFilterToUser() {
         if (Objects.isNull(this.filter) || this.filter.isEmpty()) {
             return;
         }
         ServiceManager.getUserService().addFilter(getUser(), this.filter);
         updateUser();
     }
 
     /**
      * Get user filters.
      */
     public List<String> getUserFilters() {
         return ServiceManager.getUserService().getFilters(getUser());
     }
 
     /**
      * Remove filter from user.
      */
     public void removeFilterFromUser(String filter) {
         if (Objects.isNull(filter) || filter.isEmpty()) {
             return;
         }
         ServiceManager.getUserService().removeFilter(getUser(), filter);
         updateUser();
     }
 
     /**
      * Return index of active tab.
      *
      * @return index of active tab
      */
     public int getActiveTabIndex() {
         return activeTabIndex;
     }
 
     /**
      * Set index of active tab.
      *
      * @param id
      *            index of active tab
      */
     public void setActiveTabIndex(int id) {
         this.activeTabIndex = id;
     }
 
     /**
      * Set index of active tab. Use this method when setting active tab from templates.
      * @param tabIndex
      *            index of active tab as string.
      *            String is used instead of int to allow a differentiation between a call specifying no index
      *            and a call specifying index 0.
      */
     public void setActiveTabIndexFromTemplate(String tabIndex) {
         if (Objects.nonNull(tabIndex) && !tabIndex.isEmpty()) {
             try {
                 this.activeTabIndex = Integer.parseInt(tabIndex);
             } catch (NumberFormatException e) {
                 this.activeTabIndex = 0;
             }
         }
     }
 
     /**
      * Get index of active tab for edit pages.
      *
      * @return index of active tab for edit pages
      */
     public int getEditActiveTabIndex() {
         return editActiveTabIndex;
     }
 
     /**
      * Set index of active tab for edit pages.
      *
      * @param editActiveTabIndex
      *            index of active tab for edit pages as int
      */
     public void setEditActiveTabIndex(int editActiveTabIndex) {
         this.editActiveTabIndex = editActiveTabIndex;
     }
 
     /**
      * Updates the active tab index whenever the TabChangeEvent is fired.
      *
      * @param event
      *            TabChangeEvent is fired when the user changes the tab in the
      *            current tab view
      */
     public void onTabChange(TabChangeEvent event) {
         setActiveTabIndex(event.getComponent().getChildren().indexOf(event.getTab()));
     }
 
     /**
      * Updates the active tab index whenever the TabChangeEvent is fired.
      *
      * @param event
      *            TabChangeEvent is fired when the user changes the tab in the
      *            current tab view
      */
     public void onEditTabChange(TabChangeEvent event) {
         setEditActiveTabIndex(event.getComponent().getChildren().indexOf(event.getTab()));
     }
 
     /**
      * Return boolean to disable save button.
      *
      * @return status of save button
      */
     public boolean isSaveDisabled() {
         return saveDisabled;
     }
 
     /**
      * Set boolean to disable save button.
      *
      * @param saveDisabled
      *            true or false
      */
     public void setSaveDisabled(boolean saveDisabled) {
         this.saveDisabled = saveDisabled;
     }
 
     /**
      * Get list of configurable columns.
      *
      * @return list of configurable columns
      */
     public List<SelectItem> getColumns() {
         return columns;
     }
 
     /**
      * Set list of configurable columns.
      *
      * @param columns
      *            list of columns
      */
     public void setColumns(List<SelectItem> columns) {
         this.columns = columns;
     }
 
     /**
      * Get list of selected columns.
      *
      * @return list of selected columns
      */
     public List<ListColumn> getSelectedColumns() {
         return selectedColumns;
     }
 
     /**
      * Set list of selected columns.
      *
      * @param columns
      *            list of selected columns
      */
     public void setSelectedColumns(List<ListColumn> columns) {
         this.selectedColumns = columns;
     }
 
     /**
      * Checks whether the column with the provided name 'columnName' should be shown
      * be displayed in the corresponding list view or not.
      *
      * @param columnName
      *            name of the column
      * @return true, if column should be displayed; false if column should be hidden
      */
     public boolean showColumn(String columnName) {
         for (ListColumn listColumn : this.selectedColumns) {
             if (listColumn.getTitle().equals(columnName)) {
                 return true;
             }
         }
         return false;
     }
 
     /**
      * Save selected columns to current client.
      */
     public void saveSelectedColumns() {
         try {
             ServiceManager.getListColumnService().saveSelectedColumnsToClient(selectedColumns);
         } catch (Exception e) {
             Helper.setErrorMessage(e.getLocalizedMessage());
         }
     }
 
     /**
      * Get formatted date for beans.
      *
      * @param date
      *            for formatting
      * @return formatted date or empty string
      */
     public String getFormattedDate(Date date) {
         if (Objects.nonNull(date)) {
             DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
             return dateFormat.format(date);
         }
         return "";
     }
 
     /**
      * Create and return String containing the titles of all given roles joined by a ", ".
      *
      * @param roles list of roles
      * @return String containing role titles
      */
     public String getRoleTitles(List<Role> roles) {
         return RoleService.getRoleTitles(roles);
     }
 
     /**
      * Create and return String containing the names of all given clients joined by a ", ".
      *
      * @param clients list of roles
      * @return String containing client names
      */
     public String getClientNames(List<Client> clients) {
         return ClientService.getClientNames(clients);
     }
 
     /**
      * Create and return String containing the titles of all given projects joined by a ", ".
      *
      * @param projects list of roles
      * @return String containing project titles
      */
     public String getProjectTitles(List<Project> projects) {
         return ProjectService.getProjectTitles(projects);
     }
 
     /**
      * Reset first row to 0 if given String 'keepPagination' is empty.
      *
      * @param keepPagination String parameter indicating if first row should be reset to 0
      */
     public void resetPaginator(String keepPagination) {
         if (keepPagination.isEmpty()) {
             this.setFirstRow(0);
         }
     }
 
     /**
      * Get message translation with replacements.
      * @param messageKey String
      * @param replacements list of Strings
      * @return translated String
      */
     public String formatString(String messageKey, String... replacements) {
         return Helper.getTranslation(messageKey, replacements);
     }
 
     private void updateUser() {
         try {
             user = ServiceManager.getUserService().getById(getUser().getId());
         } catch (DAOException e) {
             Helper.setErrorMessage(ERROR_LOADING_ONE, ObjectType.USER.getTranslationSingular(),
                     getUser().getId());
         }
     }
 }