Merge pull request SORMAS-Foundation#3644 from hzi-braunschweig/feature-3005-campaign-data-import-duplicate-detection

Feature 3005 campaign data import duplicate detection

Author: Martin Wahnschaffe

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataCriteria.java

@@ -15,22 +15,24 @@
 
 package de.symeda.sormas.api.campaign.data;
 
+import java.io.Serializable;
+import java.util.Date;
+
 import de.symeda.sormas.api.BaseCriteria;
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
 import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.region.CommunityReferenceDto;
 import de.symeda.sormas.api.region.DistrictReferenceDto;
 import de.symeda.sormas.api.region.RegionReferenceDto;
 
-import java.io.Serializable;
-
 public class CampaignFormDataCriteria extends BaseCriteria implements Serializable {
 
 	public static final String CAMPAIGN = "campaign";
 	public static final String CAMPAIGN_FORM_META = "campaignFormMeta";
 	public static final String REGION = "region";
 	public static final String DISTRICT = "district";
 	public static final String COMMUNITY = "community";
+	public static final String FORM_DATE = "formDate";
 
 	private static final long serialVersionUID = 8124072093160133408L;
 
@@ -39,6 +41,7 @@ public class CampaignFormDataCriteria extends BaseCriteria implements Serializab
 	private RegionReferenceDto region;
 	private DistrictReferenceDto district;
 	private CommunityReferenceDto community;
+	private Date formDate;
 
 	public CampaignReferenceDto getCampaign() {
 		return campaign;
@@ -104,4 +107,17 @@ public CampaignFormDataCriteria community(CommunityReferenceDto community) {
 		this.community = community;
 		return this;
 	}
+
+	public Date getFormDate() {
+		return formDate;
+	}
+
+	public void setFormDate(Date formDate) {
+		this.formDate = formDate;
+	}
+
+	public CampaignFormDataCriteria formDate(Date formDate) {
+		this.formDate = formDate;
+		return this;
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataDto.java

@@ -45,6 +45,7 @@ public class CampaignFormDataDto extends EntityDto {
 	public static final String REGION = "region";
 	public static final String DISTRICT = "district";
 	public static final String COMMUNITY = "community";
+	public static final String CREATING_USER = "creatingUser";
 
 	private List<CampaignFormDataEntry> formValues;
 	private CampaignReferenceDto campaign;
@@ -144,5 +145,4 @@ public void setCreatingUser(UserReferenceDto creatingUser) {
 		this.creatingUser = creatingUser;
 	}
 
-
 }

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataEntry.java

@@ -18,13 +18,13 @@
 import java.io.Serializable;
 import java.util.Collection;
 import java.util.Iterator;
-import java.util.List;
 import java.util.Objects;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
 import de.symeda.sormas.api.i18n.Strings;
+import de.symeda.sormas.api.utils.JsonDataEntry;
 
-public class CampaignFormDataEntry implements Serializable {
+public class CampaignFormDataEntry implements Serializable, JsonDataEntry {
 
 	private static final long serialVersionUID = -3096020120349257398L;
 
@@ -89,11 +89,12 @@ public static void removeNullValueEntries(Collection<CampaignFormDataEntry> entr
 	 */
 	@Override
 	public boolean equals(Object o) {
-		if (this == o) return true;
-		if (o == null || getClass() != o.getClass()) return false;
+		if (this == o)
+			return true;
+		if (o == null || getClass() != o.getClass())
+			return false;
 		CampaignFormDataEntry that = (CampaignFormDataEntry) o;
-		return Objects.equals(id, that.id) &&
-				Objects.equals(value, that.value);
+		return Objects.equals(id, that.id) && Objects.equals(value, that.value);
 	}
 
 	@Override

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataFacade.java

@@ -49,6 +49,8 @@ public interface CampaignFormDataFacade {
 
 	List<CampaignFormDataIndexDto> getIndexList(CampaignFormDataCriteria criteria, Integer first, Integer max, List<SortProperty> sortProperties);
 
+	CampaignFormDataDto getExistingData(CampaignFormDataCriteria criteria);
+
 	long count(CampaignFormDataCriteria criteria);
 
 	List<CampaignDiagramDataDto> getDiagramData(List<CampaignDiagramSeries> diagramSeries, CampaignDiagramCriteria campaignDiagramCriteria);
@@ -61,4 +63,6 @@ List<CampaignDiagramDataDto> getDiagramDataByAgeGroup(
 	List<String> getAllActiveUuids();
 
 	List<CampaignFormDataDto> getAllActiveAfter(Date date);
+
+	void overwriteCampaignFormData(CampaignFormDataDto existingData, CampaignFormDataDto newData);
 }

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

@@ -60,6 +60,7 @@ public interface Captions {
 	String actionNewForm = "actionNewForm";
 	String actionNoActions = "actionNoActions";
 	String actionOkay = "actionOkay";
+	String actionOverwrite = "actionOverwrite";
 	String actionPick = "actionPick";
 	String actionReplyingLabel = "actionReplyingLabel";
 	String actionResetFilters = "actionResetFilters";

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

@@ -219,6 +219,9 @@ public interface Strings {
 	String headingCampaignBasics = "headingCampaignBasics";
 	String headingCampaignDashboard = "headingCampaignDashboard";
 	String headingCampaignData = "headingCampaignData";
+	String headingCampaignFormDataAlreadyExisting = "headingCampaignFormDataAlreadyExisting";
+	String headingCampaignFormDataDuplicateExisting = "headingCampaignFormDataDuplicateExisting";
+	String headingCampaignFormDataDuplicateNew = "headingCampaignFormDataDuplicateNew";
 	String headingCaseComparison = "headingCaseComparison";
 	String headingCaseData = "headingCaseData";
 	String headingCaseImport = "headingCaseImport";
@@ -521,6 +524,7 @@ public interface Strings {
 	String infoSelectOrCreatePersonForContactImport = "infoSelectOrCreatePersonForContactImport";
 	String infoSelectOrCreatePersonForEventParticipant = "infoSelectOrCreatePersonForEventParticipant";
 	String infoSelectOrCreatePersonForEventParticipantImport = "infoSelectOrCreatePersonForEventParticipantImport";
+	String infoSkipOrOverrideDuplicateCampaignFormDataImport = "infoSkipOrOverrideDuplicateCampaignFormDataImport";
 	String infoSpecificCaseSearch = "infoSpecificCaseSearch";
 	String infoSpecificEventSearch = "infoSpecificEventSearch";
 	String infoStatisticsDisclaimer = "infoStatisticsDisclaimer";

sormas-api/src/main/java/de/symeda/sormas/api/utils/JsonDataEntry.java

@@ -0,0 +1,19 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api.utils;
+
+public interface JsonDataEntry {
+}

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

@@ -123,6 +123,7 @@ actionSaveChanges=Save changes
 actionBackToNationOverview=Back to Nation Overview
 actionSettings=Settings
 actionNewForm=New Form
+actionOverwrite=Overwrite
 
 # AdditionalTest
 additionalTestNewTest=New test result

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

@@ -482,6 +482,9 @@ headingEpiDataSourceCaseContacts = Contacts with Source Case
 headingExposureDetails = Exposure Details
 headingAnimalContactDetails = Animal Contact Details
 headingBurialDetails = Burial Details
+headingCampaignFormDataDuplicateNew = New Campaign Form Data
+headingCampaignFormDataDuplicateExisting = Existing Campaign Form Data
+headingCampaignFormDataAlreadyExisting = Campaign Form Data Already Existing
 
 # Info texts
 infoAddTestsToSample = To add a test result to this sample, it has to be marked as received first.
@@ -566,6 +569,7 @@ infoSelectOrCreatePersonForContact = The database already contains at least one
 infoSelectOrCreatePersonForContactImport = The database already contains at least one person that seems to be very similar to the personal details of the imported contact.<br/><br/>Please look through the list of persons. If you feel certain that one of those persons matches your contact person, select it and click on the <i>Save</i> button. Otherwise, click on <i>Create New Person</i> to create a new person for your contact.<br/><br/>If you are unsure, you can discard this window to remove the contact from the current import.
 infoSelectOrCreatePersonForEventParticipant = The database already contains at least one person that seems to be very similar to the personal details of the created event participant.<br/><br/>Please look through the list of persons. If you feel certain that one of those persons matches your event person, select it and click on the <i>Save</i> button. Otherwise, click on <i>Create New Person</i> to create a new event person for your event.<br/><br/>If you are unsure, you can discard this window and cancel the event participant creation process.
 infoSelectOrCreatePersonForEventParticipantImport = The database already contains at least one person that seems to be very similar to the personal details of the created event participant.<br/><br/>Please look through the list of persons. If you feel certain that one of those persons matches your event person, select it and click on the <i>Save</i> button. Otherwise, click on <i>Create New Person</i> to create a new event person for your event.<br/><br/>If you are unsure, you can discard this window to remove the event participant from the current import.
+infoSkipOrOverrideDuplicateCampaignFormDataImport = The database already contains a dataset for the form %s in the campaign %s for the specified community and date. Please have a look at the details for the existing dataset and choose <i>Skip</i> if you want to keep the existing data or <i>Overwrite</i> if you want to replace the existing data with the data you have imported.
 pseudonymizedCasesSelectedWarning = For the bulked-edited cases you have only limited access to the sensitive data. For those cases the value you put into "Place Description" will be ignored.
 infoPickOrCreateEventForCase = The list below contains all existing events having the same disease as the current case. Please check whether the event this case belongs to is already on this list or create a new one if it isn't.
 infoPickOrCreateEventForContact = The list below contains all existing events having the same disease as the current contact. Please check whether the event this contact belongs to is already on this list or create a new one if it isn't.

sormas-backend/src/main/java/de/symeda/sormas/backend/campaign/data/CampaignFormDataFacadeEjb.java

@@ -32,6 +32,7 @@
 import javax.ejb.LocalBean;
 import javax.ejb.Stateless;
 import javax.persistence.EntityManager;
+import javax.persistence.NoResultException;
 import javax.persistence.PersistenceContext;
 import javax.persistence.Query;
 import javax.persistence.criteria.CriteriaBuilder;
@@ -56,6 +57,8 @@
 import de.symeda.sormas.api.campaign.diagram.CampaignDiagramSeries;
 import de.symeda.sormas.api.campaign.form.CampaignFormElement;
 import de.symeda.sormas.api.campaign.form.CampaignFormElementType;
+import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.i18n.Validations;
 import de.symeda.sormas.api.infrastructure.PopulationDataCriteria;
 import de.symeda.sormas.api.infrastructure.PopulationDataDto;
 import de.symeda.sormas.api.region.AreaReferenceDto;
@@ -174,10 +177,25 @@ public CampaignFormDataDto saveCampaignFormData(CampaignFormDataDto campaignForm
 
 		CampaignFormData campaignFormData = fromDto(campaignFormDataDto);
 		CampaignFormDataEntry.removeNullValueEntries(campaignFormData.getFormValues());
+
+		validate(campaignFormDataDto);
+
 		campaignFormDataService.ensurePersisted(campaignFormData);
 		return toDto(campaignFormData);
 	}
 
+	private void validate(CampaignFormDataDto campaignFormDataDto) {
+		if (campaignFormDataDto.getRegion() == null) {
+			throw new ValidationRuntimeException(I18nProperties.getValidationError(Validations.validRegion));
+		}
+		if (campaignFormDataDto.getDistrict() == null) {
+			throw new ValidationRuntimeException(I18nProperties.getValidationError(Validations.validDistrict));
+		}
+		if (campaignFormDataDto.getCommunity() == null) {
+			throw new ValidationRuntimeException(I18nProperties.getValidationError(Validations.validCommunity));
+		}
+	}
+
 	@Override
 	public List<CampaignFormDataDto> getByUuids(List<String> uuids) {
 		return campaignFormDataService.getByUuids(uuids).stream().map(c -> convertToDto(c)).collect(Collectors.toList());
@@ -226,12 +244,37 @@ public CampaignFormDataReferenceDto getReferenceByUuid(String uuid) {
 		return toReferenceDto(campaignFormDataService.getByUuid(uuid));
 	}
 
+	@Override
+	public CampaignFormDataDto getExistingData(CampaignFormDataCriteria criteria) {
+		CriteriaBuilder cb = em.getCriteriaBuilder();
+		CriteriaQuery<CampaignFormData> cq = cb.createQuery(CampaignFormData.class);
+		Root<CampaignFormData> root = cq.from(CampaignFormData.class);
+
+		Predicate filter = AbstractAdoService
+			.and(cb, campaignFormDataService.createCriteriaFilter(criteria, cb, root), campaignFormDataService.createUserFilter(cb, cq, root));
+		if (filter != null) {
+			cq.where(filter);
+		}
+
+		cq.orderBy(cb.desc(root.get(CampaignFormData.CHANGE_DATE)));
+
+		CampaignFormData resultEntity;
+		try {
+			resultEntity = em.createQuery(cq).setMaxResults(1).getSingleResult();
+		} catch (NoResultException e) {
+			resultEntity = null;
+		}
+
+		return resultEntity != null ? toDto(resultEntity) : null;
+	}
+
 	@Override
 	public List<CampaignFormDataIndexDto> getIndexList(
 		CampaignFormDataCriteria criteria,
 		Integer first,
 		Integer max,
 		List<SortProperty> sortProperties) {
+
 		CriteriaBuilder cb = em.getCriteriaBuilder();
 		CriteriaQuery<CampaignFormDataIndexDto> cq = cb.createQuery(CampaignFormDataIndexDto.class);
 		Root<CampaignFormData> root = cq.from(CampaignFormData.class);
@@ -672,6 +715,12 @@ public long count(CampaignFormDataCriteria criteria) {
 		return em.createQuery(cq).getSingleResult();
 	}
 
+	@Override
+	public void overwriteCampaignFormData(CampaignFormDataDto existingData, CampaignFormDataDto newData) {
+		DtoHelper.fillDto(existingData, newData, true);
+		saveCampaignFormData(existingData);
+	}
+
 	private CampaignFormDataReferenceDto toReferenceDto(CampaignFormData source) {
 		if (source == null) {
 			return null;