Merge pull request SORMAS-Foundation#3040 from hzi-braunschweig/feature-2855-ExtendCampaignForm

Feature 2855 extend campaign form

Author: BarnaBartha

sormas-api/src/main/java/de/symeda/sormas/api/campaign/CampaignDto.java

@@ -1,8 +1,12 @@
 package de.symeda.sormas.api.campaign;
 
 import java.util.Date;
+import java.util.List;
+import java.util.Set;
 
 import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
+import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.user.UserReferenceDto;
 import de.symeda.sormas.api.utils.DataHelper;
 
@@ -23,6 +27,8 @@ public class CampaignDto extends EntityDto {
 	private Date startDate;
 	private Date endDate;
 	private UserReferenceDto creatingUser;
+	private Set<CampaignFormMetaReferenceDto> campaignFormMetas;
+	private List<CampaignDashboardElement> campaignDashboardElements;
 
 	public static CampaignDto build() {
 		CampaignDto campaign = new CampaignDto();
@@ -69,4 +75,20 @@ public UserReferenceDto getCreatingUser() {
 	public void setCreatingUser(UserReferenceDto creatingUser) {
 		this.creatingUser = creatingUser;
 	}
+
+	public Set<CampaignFormMetaReferenceDto> getCampaignFormMetas() {
+		return campaignFormMetas;
+	}
+
+	public void setCampaignFormMetas(Set<CampaignFormMetaReferenceDto> campaignFormMetas) {
+		this.campaignFormMetas = campaignFormMetas;
+	}
+
+	public List<CampaignDashboardElement> getCampaignDashboardElements() {
+		return campaignDashboardElements;
+	}
+
+	public void setCampaignDashboardElements(List<CampaignDashboardElement> campaignDashboardElements) {
+		this.campaignDashboardElements = campaignDashboardElements;
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/campaign/CampaignFacade.java

@@ -1,10 +1,11 @@
 package de.symeda.sormas.api.campaign;
 
-import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
-import de.symeda.sormas.api.utils.SortProperty;
+import java.util.List;
 
 import javax.ejb.Remote;
-import java.util.List;
+
+import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
+import de.symeda.sormas.api.utils.SortProperty;
 
 @Remote
 public interface CampaignFacade {
@@ -28,4 +29,8 @@ public interface CampaignFacade {
 	void deleteCampaign(String uuid);
 
 	void archiveOrDearchiveCampaign(String campaignUuid, boolean archive);
+
+	CampaignReferenceDto getReferenceByUuid(String uuid);
+
+	boolean exists(String uuid);
 }

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java

@@ -139,11 +139,18 @@ public interface Captions {
 	String Campaign_name = "Campaign.name";
 	String Campaign_startDate = "Campaign.startDate";
 	String campaignActiveCampaigns = "campaignActiveCampaigns";
+	String campaignAdditionalChart = "campaignAdditionalChart";
+	String campaignAdditionalForm = "campaignAdditionalForm";
 	String campaignAllCampaigns = "campaignAllCampaigns";
 	String campaignArchivedCampaigns = "campaignArchivedCampaigns";
 	String campaignCampaignData = "campaignCampaignData";
 	String campaignCampaignDataForm = "campaignCampaignDataForm";
 	String campaignCampaignForm = "campaignCampaignForm";
+	String campaignDashboardChart = "campaignDashboardChart";
+	String campaignDashboardChartHeight = "campaignDashboardChartHeight";
+	String campaignDashboardChartWidth = "campaignDashboardChartWidth";
+	String campaignDashboardOrder = "campaignDashboardOrder";
+	String campaignDashboardTabName = "campaignDashboardTabName";
 	String CampaignFormData_campaign = "CampaignFormData.campaign";
 	String CampaignFormData_campaignFormMeta = "CampaignFormData.campaignFormMeta";
 	String CampaignFormData_formDate = "CampaignFormData.formDate";
@@ -1184,6 +1191,7 @@ public interface Captions {
 	String regionAllRegions = "regionAllRegions";
 	String regionArchivedRegions = "regionArchivedRegions";
 	String regionName = "regionName";
+	String remove = "remove";
 	String Sample = "Sample";
 	String Sample_additionalTestingRequested = "Sample.additionalTestingRequested";
 	String Sample_associatedCase = "Sample.associatedCase";

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Strings.java

@@ -104,6 +104,10 @@ public interface Strings {
 	String confirmationMergeCaseAndDeleteOther = "confirmationMergeCaseAndDeleteOther";
 	String confirmationPickCaseAndDeleteOther = "confirmationPickCaseAndDeleteOther";
 	String confirmationReduceQuarantine = "confirmationReduceQuarantine";
+	String confirmationRemoveGridRowCancel = "confirmationRemoveGridRowCancel";
+	String confirmationRemoveGridRowConfirm = "confirmationRemoveGridRowConfirm";
+	String confirmationRemoveGridRowMessage = "confirmationRemoveGridRowMessage";
+	String confirmationRemoveGridRowTitle = "confirmationRemoveGridRowTitle";
 	String confirmationRemoveUserAsOfficer = "confirmationRemoveUserAsOfficer";
 	String confirmationUpdateCompleteness = "confirmationUpdateCompleteness";
 	String confirmNetworkDiagramTooManyContacts = "confirmNetworkDiagramTooManyContacts";
@@ -185,6 +189,8 @@ public interface Strings {
 	String headingArchiveCase = "headingArchiveCase";
 	String headingArchiveEvent = "headingArchiveEvent";
 	String headingArchivingNotPossible = "headingArchivingNotPossible";
+	String headingCampaignBasics = "headingCampaignBasics";
+	String headingCampaignDashboard = "headingCampaignDashboard";
 	String headingCampaignData = "headingCampaignData";
 	String headingCaseComparison = "headingCaseComparison";
 	String headingCaseData = "headingCaseData";
@@ -468,6 +474,7 @@ public interface Strings {
 	String infoStatisticsFilter = "infoStatisticsFilter";
 	String infoStatisticsResults = "infoStatisticsResults";
 	String infoSurveillanceDashboard = "infoSurveillanceDashboard";
+	String infoUsageOfEditableCampaignGrids = "infoUsageOfEditableCampaignGrids";
 	String infoUserEmail = "infoUserEmail";
 	String infoUserPhoneNumber = "infoUserPhoneNumber";
 	String infoWeeklyReportsView = "infoWeeklyReportsView";

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Validations.java

@@ -14,6 +14,7 @@ public interface Validations {
 	String afterDateSoft = "afterDateSoft";
 	String beforeDate = "beforeDate";
 	String beforeDateSoft = "beforeDateSoft";
+	String campaignDashboardChartPercentage = "campaignDashboardChartPercentage";
 	String campaignFormDependingOnNotFound = "campaignFormDependingOnNotFound";
 	String campaignFormDependingOnValuesMissing = "campaignFormDependingOnValuesMissing";
 	String campaignFormElementDuplicateId = "campaignFormElementDuplicateId";

sormas-api/src/main/resources/captions.properties

@@ -52,6 +52,7 @@ inaccessibleValue=Confidential
 numberOfCharacters=Number of characters: %d / %d
 facility=Facility
 pointOfEntry=Point of entry
+remove=Remove
 
 # About
 aboutSormasVersion=SORMAS Version
@@ -195,6 +196,13 @@ campaignCampaignData=Campaign Data
 campaignCampaignDataForm=Data Form
 campaignCampaignForm=Form
 campaignValidateForms=Validate Forms
+campaignAdditionalForm=Add form
+campaignAdditionalChart=Add chart
+campaignDashboardChart=Campaign data chart
+campaignDashboardTabName=Tab name
+campaignDashboardChartWidth=Width in %
+campaignDashboardChartHeight=Height in %
+campaignDashboardOrder=Order
 
 Campaign=Campaign
 Campaign.name=Name

sormas-api/src/main/resources/strings.properties

@@ -167,6 +167,10 @@ confirmationRemoveUserAsOfficer = The user roles of this user have changed. Savi
 confirmationExtendQuarantine=Are you sure you want to extend the quarantine?
 confirmationReduceQuarantine=Are you sure you want to reduce the quarantine?
 confirmationExtendFollowUp=Would you also want the follow-up period to be extended accordingly?
+confirmationRemoveGridRowTitle=Confirm remove
+confirmationRemoveGridRowMessage=Are you sure you want to remove this row?
+confirmationRemoveGridRowConfirm=Yes
+confirmationRemoveGridRowCancel=No
 # Entities
 entityAction=Action
 entityActions=Actions
@@ -234,7 +238,9 @@ headingAnimalContacts = Animal Contacts
 headingArchiveCampaign = Archive Campaign
 headingArchiveCase = Archive case
 headingArchiveEvent = Archive event
+headingCampaignBasics = Campaign basics
 headingCampaignData = Campaign data
+headingCampaignDashboard = Campaign dashboard
 headingCaseData = Case data
 headingCaseImport = Case Import
 headingPointOfEntryImport = Point of Entry Import
@@ -523,6 +529,7 @@ infoContactsViewRegionDistrictFilter = When you select a region and/or district
 infoDeveloperOptions = You can use the controls below to generate dummy cases and contacts based on the selected restraints. Please note that generating a lot of data at once might take some time.
 infoCreateNewSampleDiscardsChanges = Creating a new sample will discard all unsaved changes made to this case
 infoCreateNewSampleDiscardsChangesEventParticipant = Creating a new sample will discard all unsaved changes made to this event participant
+infoUsageOfEditableCampaignGrids = You can edit the campaign data and dashboard definitions by clicking inside one of the cells in the grid, and you can reorder the dashboard elements by dragging and dropping the grid rows
 
 # Messages
 messageActivateAccount = Account has to be activated

sormas-api/src/main/resources/validations.properties

@@ -109,6 +109,7 @@ campaignFormTranslationLanguageCodeRequired = All translations must specify a la
 campaignFormElementDuplicateId = Field IDs need to be unique, but the campaign form contains at least two fields with ID %s.
 errorsInForm = There are errors in the form you tried to save. Please check the fields highlighted in red and make sure to only enter valid values.
 campaignFormInvalidIdInListElements = The ID %s in the campaign form list definition is not associated to any element of the form.
+campaignDashboardChartPercentage = Value must be a number that is multiple of 5!
 sormasToSormasCaseExists=This case already exists
 sormasToSormasContactExists=This contact already exists
 sormasToSormasContactCaseNotExists=The linked case does not exist

sormas-backend/src/main/java/de/symeda/sormas/backend/campaign/Campaign.java

@@ -1,20 +1,28 @@
 package de.symeda.sormas.backend.campaign;
 
-import de.symeda.auditlog.api.Audited;
-import de.symeda.auditlog.api.AuditedIgnore;
-import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
-import de.symeda.sormas.backend.common.CoreAdo;
-import de.symeda.sormas.backend.user.User;
-import org.hibernate.annotations.Type;
+import java.util.Date;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
 import javax.persistence.Column;
 import javax.persistence.Entity;
+import javax.persistence.FetchType;
 import javax.persistence.JoinColumn;
+import javax.persistence.JoinTable;
+import javax.persistence.ManyToMany;
 import javax.persistence.ManyToOne;
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
-import java.util.Date;
-import java.util.List;
+
+import org.hibernate.annotations.Type;
+
+import de.symeda.auditlog.api.Audited;
+import de.symeda.auditlog.api.AuditedIgnore;
+import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
+import de.symeda.sormas.backend.campaign.form.CampaignFormMeta;
+import de.symeda.sormas.backend.common.CoreAdo;
+import de.symeda.sormas.backend.user.User;
 
 @Entity(name = "campaigns")
 @Audited
@@ -23,6 +31,7 @@ public class Campaign extends CoreAdo {
 	private static final long serialVersionUID = -2744033662114826543L;
 
 	public static final String TABLE_NAME = "campaigns";
+	public static final String CAMPAIGN_CAMPAIGNFORMMETA_TABLE_NAME = "campaign_campaignformmeta";
 
 	public static final String NAME = "name";
 	public static final String DESCRIPTION = "description";
@@ -38,6 +47,7 @@ public class Campaign extends CoreAdo {
 	private User creatingUser;
 	private boolean archived;
 	private List<CampaignDashboardElement> dashboardElements;
+	private Set<CampaignFormMeta> campaignFormMetas = new HashSet<>();
 
 	@Column(length = 255)
 	public String getName() {
@@ -109,4 +119,17 @@ public List<CampaignDashboardElement> getDashboardElements() {
 	public void setDashboardElements(List<CampaignDashboardElement> dashboardElements) {
 		this.dashboardElements = dashboardElements;
 	}
+
+	@AuditedIgnore
+	@ManyToMany(fetch = FetchType.LAZY)
+	@JoinTable(name = CAMPAIGN_CAMPAIGNFORMMETA_TABLE_NAME,
+		joinColumns = @JoinColumn(name = "campaign_id"),
+		inverseJoinColumns = @JoinColumn(name = "campaignformmeta_id"))
+	public Set<CampaignFormMeta> getCampaignFormMetas() {
+		return campaignFormMetas;
+	}
+
+	public void setCampaignFormMetas(Set<CampaignFormMeta> campaignFormMetas) {
+		this.campaignFormMetas = campaignFormMetas;
+	}
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/campaign/CampaignFacadeEjb.java

@@ -2,8 +2,10 @@
 
 import java.sql.Timestamp;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.Date;
 import java.util.List;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import javax.ejb.EJB;
@@ -20,17 +22,21 @@
 import javax.persistence.criteria.Root;
 import javax.validation.constraints.NotNull;
 
+import org.apache.commons.collections.CollectionUtils;
+
 import de.symeda.sormas.api.campaign.CampaignCriteria;
 import de.symeda.sormas.api.campaign.CampaignDto;
 import de.symeda.sormas.api.campaign.CampaignFacade;
 import de.symeda.sormas.api.campaign.CampaignIndexDto;
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
 import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
+import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.i18n.I18nProperties;
 import de.symeda.sormas.api.i18n.Strings;
 import de.symeda.sormas.api.user.UserRight;
 import de.symeda.sormas.api.user.UserRole;
 import de.symeda.sormas.api.utils.SortProperty;
+import de.symeda.sormas.backend.campaign.form.CampaignFormMetaService;
 import de.symeda.sormas.backend.common.AbstractAdoService;
 import de.symeda.sormas.backend.common.AbstractDomainObject;
 import de.symeda.sormas.backend.user.User;
@@ -49,6 +55,8 @@ public class CampaignFacadeEjb implements CampaignFacade {
 	@EJB
 	private CampaignService campaignService;
 	@EJB
+	private CampaignFormMetaService campaignFormMetaService;
+	@EJB
 	private UserService userService;
 	@EJB
 	private UserRoleConfigFacadeEjbLocal userRoleConfigFacade;
@@ -164,11 +172,19 @@ public Campaign fromDto(@NotNull CampaignDto source) {
 		target.setEndDate(source.getEndDate());
 		target.setName(source.getName());
 		target.setStartDate(source.getStartDate());
+		final Set<CampaignFormMetaReferenceDto> campaignFormMetas = source.getCampaignFormMetas();
+		if (!CollectionUtils.isEmpty(campaignFormMetas)) {
+			target.setCampaignFormMetas(
+				campaignFormMetas.stream()
+					.map(campaignFormMetaReferenceDto -> campaignFormMetaService.getByUuid(campaignFormMetaReferenceDto.getUuid()))
+					.collect(Collectors.toSet()));
+		}
+		target.setDashboardElements(source.getCampaignDashboardElements());
 
 		return target;
 	}
 
-	public static CampaignDto toDto(Campaign source) {
+	public CampaignDto toDto(Campaign source) {
 
 		if (source == null) {
 			return null;
@@ -182,6 +198,9 @@ public static CampaignDto toDto(Campaign source) {
 		target.setEndDate(source.getEndDate());
 		target.setName(source.getName());
 		target.setStartDate(source.getStartDate());
+		target.setCampaignFormMetas(
+			source.getCampaignFormMetas().stream().map(campaignFormMeta -> campaignFormMeta.toReference()).collect(Collectors.toSet()));
+		target.setCampaignDashboardElements(source.getDashboardElements());
 
 		return target;
 	}
@@ -206,7 +225,7 @@ public List<CampaignDashboardElement> getCampaignDashboardElements(String campai
 				}
 			});
 		}
-		return result;
+		return result.stream().sorted(Comparator.comparingInt(CampaignDashboardElement::getOrder)).collect(Collectors.toList());
 	}
 
 	@Override
@@ -247,6 +266,16 @@ public void archiveOrDearchiveCampaign(String campaignUuid, boolean archive) {
 		campaignService.ensurePersisted(campaign);
 	}
 
+	@Override
+	public CampaignReferenceDto getReferenceByUuid(String uuid) {
+		return toReferenceDto(campaignService.getByUuid(uuid));
+	}
+
+	@Override
+	public boolean exists(String uuid) {
+		return campaignService.exists(uuid);
+	}
+
 	public static CampaignReferenceDto toReferenceDto(Campaign entity) {
 		if (entity == null) {
 			return null;