Add data type to CSV import templates

Author: vidi42

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

@@ -442,8 +442,8 @@ public interface Captions {
 	String Contact_reportDateTime = "Contact.reportDateTime";
 	String Contact_reportingUser = "Contact.reportingUser";
 	String Contact_reportLat = "Contact.reportLat";
-	String Contact_reportLon = "Contact.reportLon";
 	String Contact_reportLatLonAccuracy = "Contact.reportLatLonAccuracy";
+	String Contact_reportLon = "Contact.reportLon";
 	String Contact_resultingCase = "Contact.resultingCase";
 	String Contact_resultingCaseUser = "Contact.resultingCaseUser";
 	String Contact_tracingApp = "Contact.tracingApp";

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

@@ -104,6 +104,7 @@ public interface Strings {
 	String confirmationPickCaseAndDeleteOther = "confirmationPickCaseAndDeleteOther";
 	String confirmationRemoveUserAsOfficer = "confirmationRemoveUserAsOfficer";
 	String confirmationUpdateCompleteness = "confirmationUpdateCompleteness";
+	String date = "date";
 	String day = "day";
 	String DiseaseNetworkDiagram_Classification_HEALTHY = "DiseaseNetworkDiagram.Classification.HEALTHY";
 	String DiseaseNetworkDiagram_heading = "DiseaseNetworkDiagram.heading";
@@ -642,6 +643,7 @@ public interface Strings {
 	String min = "min";
 	String mmhg = "mmhg";
 	String month = "month";
+	String nameOf = "nameOf";
 	String no = "no";
 	String none = "none";
 	String notAnswered = "notAnswered";
@@ -678,6 +680,7 @@ public interface Strings {
 	String notificationVisitCompleted = "notificationVisitCompleted";
 	String notificationVisitCompletedSubject = "notificationVisitCompletedSubject";
 	String notSpecified = "notSpecified";
+	String number = "number";
 	String numberEight = "numberEight";
 	String numberEleven = "numberEleven";
 	String numberFive = "numberFive";
@@ -739,6 +742,7 @@ public interface Strings {
 	String reportedBy = "reportedBy";
 	String reportedOn = "reportedOn";
 	String step = "step";
+	String text = "text";
 	String toCase = "toCase";
 	String total = "total";
 	String until = "until";

…s/backend/importexport/ImportColumn.java …ormas/api/importexport/ImportColumn.javasormas-backend/src/main/java/de/symeda/sormas/backend/importexport/ImportColumn.java renamed to sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportColumn.java sormas-backend/src/main/java/de/symeda/sormas/backend/importexport/ImportColumn.java renamed to sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportColumn.java

@@ -16,12 +16,19 @@
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 
-package de.symeda.sormas.backend.importexport;
+package de.symeda.sormas.api.importexport;
 
+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.
  *
@@ -36,10 +43,13 @@ public class ImportColumn {
 
 	private String caption;
 
-	private ImportColumn(String entityName, String columnName, String caption) {
+	private String dataDescription;
+
+	private ImportColumn(String entityName, String columnName, String caption, String dataDescription) {
 		this.entityName = entityName;
 		this.columnName = columnName;
 		this.caption = caption;
+		this.dataDescription = dataDescription;
 	}
 
 	public String getEntityName() {
@@ -54,10 +64,15 @@ public String getCaption() {
 		return caption;
 	}
 
-	public static ImportColumn from(Class<?> entityType, String columnName) {
+	public String getDataDescription() {
+		return dataDescription;
+	}
+
+	public static ImportColumn from(Class<?> entityType, String columnName, Class<?> fieldType) {
 		String entityName = DataHelper.getHumanClassName(entityType);
-		String caption = calculateCaption(entityName, columnName);
-		return new ImportColumn(entityName, columnName, caption);
+		String caption = computeCaption(entityName, columnName);
+		String dataType = computeDataType(fieldType);
+		return new ImportColumn(entityName, columnName, caption, dataType);
 	}
 
 	/**
@@ -75,7 +90,7 @@ public static ImportColumn from(Class<?> entityType, String columnName) {
 	 * @param columnName column name from the CSV
 	 * @return list of captions for each column name.
 	 */
-	private static String calculateCaption(String entityName, String columnName) {
+	private static String computeCaption(String entityName, String columnName) {
 		if (StringUtils.contains(columnName, ".")) {
 			String[] parts = columnName.split("\\.");
 			String fieldName = parts[parts.length - 1];
@@ -84,4 +99,32 @@ private static String calculateCaption(String entityName, String columnName) {
 			return I18nProperties.getPrefixCaption(entityName, 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: <code>${activeDiseases}</code>.
+	 *
+	 * @param fieldType type of a CSV field (column)
+	 * @return a data type description, example or placeholder
+	 */
+	private static String computeDataType(Class<?> fieldType) {
+		if (String.class.isAssignableFrom(fieldType)) {
+			return I18nProperties.getString(Strings.text);
+		} 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));
+		} else if (Disease.class.isAssignableFrom(fieldType)) {
+			return "${activeDiseases}";
+		} else if (fieldType.isEnum()) {
+			List<String> enumNames = new ArrayList<>();
+			for (Object enumConstant : fieldType.getEnumConstants()) {
+				enumNames.add(((Enum<?>) enumConstant).name());
+			}
+			return StringUtils.join(enumNames, ",");
+		} else if (Number.class.isAssignableFrom(fieldType)) {
+			return I18nProperties.getString(Strings.number);
+		} else {
+			return "";
+		}
+	}
 }

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

@@ -926,6 +926,7 @@ Facility.externalID=External ID
 Facility.latitude=Latitude
 Facility.longitude=Longitude
 Facility.name=Name
+Facility.publicOwnership=Public ownership
 Facility.region=Region
 Facility.type=Facility type
 Facility.typeGroup=Facility category

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

@@ -702,6 +702,7 @@ facilityAllLaboratories = All laboratories
 Facility.NO_FACILITY = Home or other place
 Facility.OTHER_FACILITY = Other health facility
 Facility.OTHER_LABORATORY = Other laboratory
+Facility.publicOwnership = Public ownership
 Facility.latitude = Latitude
 Facility.longitude = Longitude
 

sormas-api/src/main/resources/captions_de-CH.properties

@@ -926,6 +926,7 @@ Facility.externalID=Externe ID
 Facility.latitude=Breitengrad
 Facility.longitude=Längengrad
 Facility.name=Name
+Facility.publicOwnership=Öffentliches Eigentum
 Facility.region=Kanton
 Facility.type=Art der Einrichtung
 Facility.typeGroup=Kategorie der Einrichtung

sormas-api/src/main/resources/captions_de-DE.properties

@@ -926,6 +926,7 @@ Facility.externalID=Externe ID
 Facility.latitude=Breitengrad
 Facility.longitude=Längengrad
 Facility.name=Name
+Facility.publicOwnership=Öffentliches Eigentum
 Facility.region=Bundesland
 Facility.type=Art der Einrichtung
 Facility.typeGroup=Einrichtungskategorie

sormas-api/src/main/resources/captions_en-AF.properties

@@ -922,6 +922,7 @@ Facility.externalID=External ID
 Facility.latitude=Latitude
 Facility.longitude=Longitude
 Facility.name=Name
+Facility.publicOwnership=Public ownership
 Facility.region=Province
 Facility.type=Facility type
 Facility.typeGroup=Facility category

sormas-api/src/main/resources/captions_es-CU.properties

@@ -922,6 +922,7 @@ Facility.externalID=ID externa
 Facility.latitude=Latitud
 Facility.longitude=Longitud
 Facility.name=Nombre
+Facility.publicOwnership=Propiedad pública
 Facility.region=Provincia
 Facility.type=Tipo de instalación
 Facility.typeGroup=Categoría de instalación

sormas-api/src/main/resources/captions_es-EC.properties

@@ -922,6 +922,7 @@ Facility.externalID=Id externo
 Facility.latitude=Latitud
 Facility.longitude=Longitud
 Facility.name=Name
+Facility.publicOwnership=Propiedad pública
 Facility.region=Region
 Facility.type=Facility type
 Facility.typeGroup=Facility category