Merge pull request SORMAS-Foundation#3000 from hzi-braunschweig/feature-1999-import-campaign-form-data

Feature 1999 import campaign form data

Author: Martin Wahnschaffe

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

@@ -20,7 +20,11 @@
 
 package de.symeda.sormas.api.campaign.data;
 
+import java.util.Date;
+import java.util.List;
+
 import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.ImportIgnore;
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
 import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.region.CommunityReferenceDto;
@@ -29,9 +33,6 @@
 import de.symeda.sormas.api.user.UserReferenceDto;
 import de.symeda.sormas.api.utils.DataHelper;
 
-import java.util.Date;
-import java.util.List;
-
 public class CampaignFormDataDto extends EntityDto {
 
 	private static final long serialVersionUID = -8087195060395038093L;
@@ -71,6 +72,12 @@ public static CampaignFormDataDto build(
 		return campaignFormData;
 	}
 
+	public static CampaignFormDataDto build() {
+		CampaignFormDataDto campaignFormData = new CampaignFormDataDto();
+		campaignFormData.setUuid(DataHelper.createUuid());
+		return campaignFormData;
+	}
+
 	public List<CampaignFormDataEntry> getFormValues() {
 		return formValues;
 	}
@@ -79,6 +86,7 @@ public void setFormValues(List<CampaignFormDataEntry> formValues) {
 		this.formValues = formValues;
 	}
 
+	@ImportIgnore
 	public CampaignFormMetaReferenceDto getCampaignFormMeta() {
 		return campaignFormMeta;
 	}
@@ -87,6 +95,7 @@ public void setCampaignFormMeta(CampaignFormMetaReferenceDto campaignFormMeta) {
 		this.campaignFormMeta = campaignFormMeta;
 	}
 
+	@ImportIgnore
 	public CampaignReferenceDto getCampaign() {
 		return campaign;
 	}

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

@@ -357,6 +357,7 @@ public interface Strings {
 	String headingSamplesDeleted = "headingSamplesDeleted";
 	String headingSaveNotification = "headingSaveNotification";
 	String headingSaveUser = "headingSaveUser";
+	String headingSelectCampaign = "headingSelectCampaign";
 	String headingSelectSourceCase = "headingSelectSourceCase";
 	String headingSetOutbreakStatus = "headingSetOutbreakStatus";
 	String headingSignsAndSymptoms = "headingSignsAndSymptoms";

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

@@ -62,6 +62,7 @@ public interface Validations {
 	String importRegionAlreadyExists = "importRegionAlreadyExists";
 	String importRegionNotUnique = "importRegionNotUnique";
 	String importUnexpectedError = "importUnexpectedError";
+	String importWrongDataTypeError = "importWrongDataTypeError";
 	String investigationStatusUnclassifiedCase = "investigationStatusUnclassifiedCase";
 	String noCommunityInDistrict = "noCommunityInDistrict";
 	String noDistrictInRegion = "noDistrictInRegion";

sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportColumn.java

@@ -1,33 +1,31 @@
 /*
  * 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.importexport;
 
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+import org.apache.commons.lang3.StringUtils;
+
 import de.symeda.sormas.api.Disease;
 import de.symeda.sormas.api.ReferenceDto;
 import de.symeda.sormas.api.i18n.I18nProperties;
 import de.symeda.sormas.api.i18n.Strings;
 import de.symeda.sormas.api.utils.DataHelper;
-import org.apache.commons.lang3.StringUtils;
-
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
 
 /**
  * Detailed import template column entity with information like entity name, column name, caption and data type.
@@ -52,6 +50,12 @@ private ImportColumn(String entityName, String columnName, String caption, Strin
 		this.dataDescription = dataDescription;
 	}
 
+	public ImportColumn(String columnName, String caption, String dataDescription) {
+		this.columnName = columnName;
+		this.caption = caption;
+		this.dataDescription = dataDescription;
+	}
+
 	public String getEntityName() {
 		return entityName;
 	}
@@ -86,8 +90,10 @@ public static ImportColumn from(Class<?> entityType, String columnName, Class<?>
 	 * <p/>
 	 * The result is a list with the same length as the <code>columnNames</code>
 	 *
-	 * @param entityName name of the entity from which the field is part of
-	 * @param columnName column name from the CSV
+	 * @param entityName
+	 *            name of the entity from which the field is part of
+	 * @param columnName
+	 *            column name from the CSV
 	 * @return list of captions for each column name.
 	 */
 	private static String computeCaption(String entityName, String columnName) {
@@ -101,10 +107,13 @@ private static String computeCaption(String entityName, String columnName) {
 	}
 
 	/**
-	 * Computes the data type accepted for a certain field type. For values which cannot be determined at start a placeholder will be used (ex: {@link ImportFacade#ACTIVE_DISEASES_PLACEHOLDER}).
+	 * Computes the data type accepted for a certain field type. For values which cannot be determined at start a placeholder will be used
+	 * (ex: {@link ImportFacade#ACTIVE_DISEASES_PLACEHOLDER}).
 	 *
-	 * @param fieldType type of a CSV field (column)
-	 * @param currentSeparator current CSV configured separator, used to identify a different one for joining lists
+	 * @param fieldType
+	 *            type of a CSV field (column)
+	 * @param currentSeparator
+	 *            current CSV configured separator, used to identify a different one for joining lists
 	 * @return a data type description, example or placeholder
 	 */
 	private static String computeDataType(Class<?> fieldType, char currentSeparator) {
@@ -115,7 +124,7 @@ private static String computeDataType(Class<?> fieldType, char currentSeparator)
 		} else if (Date.class.isAssignableFrom(fieldType)) {
 			return I18nProperties.getString(Strings.date) + ": dd/MM/yyyy";
 		} else if (ReferenceDto.class.isAssignableFrom(fieldType)) {
-			return String.format(I18nProperties.getString(Strings.nameOf), DataHelper.getHumanClassName(fieldType));
+			return String.format(I18nProperties.getString(Strings.nameOf), DataHelper.getHumanClassCaption(fieldType));
 		} else if (Disease.class.isAssignableFrom(fieldType)) {
 			return ImportFacade.ACTIVE_DISEASES_PLACEHOLDER;
 		} else if (fieldType.isEnum()) {

sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportFacade.java

@@ -33,6 +33,8 @@ public interface ImportFacade {
 	 */
 	void generateCaseImportTemplateFile() throws IOException;
 
+	void generateCampaignFormImportTemplateFile(String campaignFormUuid) throws IOException;
+
 	void generateCaseContactImportTemplateFile() throws IOException;
 
 	void generateCaseLineListingImportTemplateFile() throws IOException;
@@ -55,6 +57,8 @@ public interface ImportFacade {
 
 	String getCaseImportTemplateFilePath();
 
+	String getCampaignFormImportTemplateFilePath();
+
 	String getPointOfEntryImportTemplateFilePath();
 
 	String getPopulationDataImportTemplateFilePath();

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

@@ -206,6 +206,10 @@ public static String capitalize(String input) {
 		return input.substring(0, 1).toUpperCase() + input.substring(1);
 	}
 
+	public static String lowercaseFirst(String input) {
+		return input.substring(0, 1).toLowerCase() + input.substring(1);
+	}
+
 	public static BigDecimal getTruncatedBigDecimal(BigDecimal number) {
 		return number.remainder(BigDecimal.ONE).compareTo(BigDecimal.ZERO) == 0 ? number.setScale(0, RoundingMode.HALF_UP) : number;
 	}
@@ -299,6 +303,15 @@ public static String getHumanClassName(Class<?> classType) {
 		return className;
 	}
 
+	public static String getHumanClassCaption(Class<?> classType) {
+
+		String className = classType.getSimpleName();
+		className = className.replaceAll("Dto$", "");
+		className = className.replaceAll("Reference$", "");
+		I18nProperties.getCaption(DataHelper.lowercaseFirst(className), className);
+		return className;
+	}
+
 	/**
 	 * @return null when NumberFormatException is thrown
 	 */

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

@@ -368,6 +368,7 @@ headingRequestedPathogenTests = Requested pathogen tests:
 headingResults = Results
 headingSamplesDeleted = Samples deleted
 headingSaveNotification = Save notification
+headingSelectCampaign = Select a campaign
 headingSetOutbreakStatus = Set status of all districts:
 headingSignsAndSymptoms = Clinical Signs and Symptoms
 headingTasksDeleted = Tasks deleted

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

@@ -27,6 +27,7 @@ importCasesPropertyTypeNotAllowed = Property type %s not allowed when importing
 importPropertyTypeNotAllowed = Property type %s not allowed
 importCasesUnexpectedError = Unexpected error when trying to import this case. Please send your error report file to an administrator and remove this case from your import file.
 importUnexpectedError = Unexpected error when trying to import this row. Please send your error report file to an administrator and remove this row from your import file.
+importWrongDataTypeError = Value %s in column %s does not match expected data type.
 importCommunityNotUnique = Invalid value %s in column %s; Community name is not unique in the chosen district, make sure there is only one community with this name belonging to the chosen district in the database
 importDistrictNotUnique = Invalid value %s in column %s; District name is not unique in the chosen region, make sure there is only one district with this name belonging to the chosen region in the database
 importEntryDoesNotExist = Invalid value %s in column %s; Entry does not exist in the database or is archived

sormas-api/src/test/java/de/symeda/sormas/api/utils/DataHelperTest.java

@@ -7,6 +7,7 @@
 
 import de.symeda.sormas.api.Disease;
 import de.symeda.sormas.api.caze.CaseDataDto;
+import de.symeda.sormas.api.region.RegionReferenceDto;
 
 public class DataHelperTest {
 
@@ -15,6 +16,7 @@ public void testGetHumanClassName() {
 
 		assertEquals("CaseData", DataHelper.getHumanClassName(CaseDataDto.class));
 		assertEquals("Disease", DataHelper.getHumanClassName(Disease.class));
+		assertEquals("RegionReference", DataHelper.getHumanClassName(RegionReferenceDto.class));
 	}
 
 	@Test