Merge pull request SORMAS-Foundation#2808 from hzi-braunschweig/feature-2753-CampaignDiagram

Feature 2753 campaign diagram

Author: BarnaBartha

sormas-api/src/main/java/de/symeda/sormas/api/campaign/diagram/CampaignDiagramDataDto.java

@@ -14,10 +14,18 @@ public class CampaignDiagramDataDto implements Serializable {
 	private Object groupingKey;
 	private String groupingCaption;
 
-	public CampaignDiagramDataDto(String formMetaUuid, String formId, String fieldId, Object valueSum, Object groupingKey, String groupingCaption) {
+	public CampaignDiagramDataDto(
+		String formMetaUuid,
+		String formId,
+		String fieldId,
+		String fieldCaption,
+		Object valueSum,
+		Object groupingKey,
+		String groupingCaption) {
 		this.formMetaUuid = formMetaUuid;
 		this.formId = formId;
 		this.fieldId = fieldId;
+		this.fieldCaption = fieldCaption;
 		this.valueSum = valueSum;
 		this.groupingKey = groupingKey;
 		this.groupingCaption = groupingCaption;

sormas-api/src/main/java/de/symeda/sormas/api/campaign/form/CampaignFormElement.java

@@ -4,6 +4,10 @@
 
 public class CampaignFormElement implements Serializable {
 
+	public static final String ID = "id";
+	public static final String TYPE = "type";
+	public static final String CAPTION = "caption";
+
 	private static final long serialVersionUID = 5553496750859734167L;
 
 	public static final String[] VALID_TYPES = {

sormas-api/src/main/java/de/symeda/sormas/api/region/RegionFacade.java

@@ -29,6 +29,8 @@
 @Remote
 public interface RegionFacade {
 
+	List<RegionReferenceDto> getAllActiveByArea(String areaUuid);
+
 	List<RegionReferenceDto> getAllActiveAsReference();
 
 	List<RegionDto> getAllAfter(Date date);

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

@@ -23,7 +23,6 @@
 import java.sql.Timestamp;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Optional;
 import java.util.stream.Collectors;
 
 import javax.ejb.EJB;
@@ -53,7 +52,8 @@
 import de.symeda.sormas.api.campaign.diagram.CampaignDiagramDataDto;
 import de.symeda.sormas.api.campaign.diagram.CampaignDiagramSeries;
 import de.symeda.sormas.api.campaign.form.CampaignFormElement;
-import de.symeda.sormas.api.campaign.form.CampaignFormMetaDto;
+import de.symeda.sormas.api.campaign.form.CampaignFormElementType;
+import de.symeda.sormas.api.region.AreaReferenceDto;
 import de.symeda.sormas.api.region.DistrictReferenceDto;
 import de.symeda.sormas.api.region.RegionReferenceDto;
 import de.symeda.sormas.api.user.UserRight;
@@ -66,6 +66,7 @@
 import de.symeda.sormas.backend.campaign.form.CampaignFormMetaFacadeEjb;
 import de.symeda.sormas.backend.campaign.form.CampaignFormMetaService;
 import de.symeda.sormas.backend.common.AbstractDomainObject;
+import de.symeda.sormas.backend.region.Area;
 import de.symeda.sormas.backend.region.Community;
 import de.symeda.sormas.backend.region.CommunityFacadeEjb;
 import de.symeda.sormas.backend.region.CommunityService;
@@ -293,41 +294,56 @@ public List<CampaignDiagramDataDto> getDiagramData(
 
 		for (CampaignDiagramSeries diagramSeries : diagramSeriesList) {
 
-			// TODO check data type of field
-			// - int: as-is
-			// - yes-no/other: CampaignDiagramSeries.fieldValue should be defined -> count the number of form data that match the value
-
 			//@formatter:off
+			final AreaReferenceDto area = campaignDiagramCriteria.getArea();
 			final RegionReferenceDto region = campaignDiagramCriteria.getRegion();
 			final DistrictReferenceDto district = campaignDiagramCriteria.getDistrict();
 			final CampaignReferenceDto campaign = campaignDiagramCriteria.getCampaign();
+			
+			final String areaFilter = area != null ? " AND " + Area.TABLE_NAME + "." + Area.UUID + " = '" + area.getUuid() + "'": "";
 			final String regionFilter = region != null ? " AND " + CampaignFormData.REGION + "." + Region.UUID + " = '" + region.getUuid() + "'": "";
 			final String districtFilter = district != null ? " AND " + CampaignFormData.DISTRICT + "." + District.UUID + " = '" + district.getUuid() + "'" : "";
 			final String campaignFilter = campaign != null ? " AND " + Campaign.TABLE_NAME + "." + Campaign.UUID + " = '" + campaign.getUuid() +  "'" : "";
 			final String jurisdictionGrouping =
-					district != null ? ", " + Community.TABLE_NAME + "." + Community.UUID + ", " + Community.TABLE_NAME + "." + Community.NAME :
-					region != null ? ", " + District.TABLE_NAME + "." + District.UUID + ", " + District.TABLE_NAME + "." + District.NAME : "";
+					(district != null ? ", " + Community.TABLE_NAME + "." + Community.UUID + ", " + Community.TABLE_NAME + "." + Community.NAME :
+					region != null ? ", " + District.TABLE_NAME + "." + District.UUID + ", " + District.TABLE_NAME + "." + District.NAME : "")
+							+ ", " + Region.TABLE_NAME + "." + Region.UUID + ", " + Region.TABLE_NAME + "." + Region.NAME;
+			
 			Query seriesDataQuery = em.createNativeQuery(
-					"SELECT " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.UUID  + " as campaignFormUuid," + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID
-							+ ", jsonData->>'" + CampaignFormDataEntry.ID + "'"
-							+ ", sum((jsonData->>'" + CampaignFormDataEntry.VALUE + "')\\:\\:int)"
-							+ ", " + Region.TABLE_NAME + "." + Region.UUID + ", " + Region.TABLE_NAME + "." + Region.NAME
+					"SELECT " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.UUID  + " as formUuid,"
+							+ CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID + " as formId"
+							+ ", jsonData->>'" + CampaignFormDataEntry.ID + "' as fieldId"
+							+ ", jsonMeta->>'" + CampaignFormElement.CAPTION + "' as fieldCaption"
+							+ ", CASE"
+							+ " WHEN (jsonMeta ->> '" + CampaignFormElement.TYPE + "')  = '" + CampaignFormElementType.NUMBER.toString() + "' THEN sum((jsonData->>'" + CampaignFormDataEntry.VALUE + "')\\:\\:int)"
+							+ " ELSE count((jsonData->>'" + CampaignFormDataEntry.VALUE + "') = '" + diagramSeries.getFieldValue() + "')"
+		      				+ " END as sumValue"
+							+ ", " + Region.TABLE_NAME + "." + Region.UUID
+							+ ", " + Region.TABLE_NAME + "." + Region.NAME
 							+ " FROM " + CampaignFormData.TABLE_NAME
 							+ " LEFT JOIN " + CampaignFormMeta.TABLE_NAME + " ON " + CampaignFormData.CAMPAIGN_FORM_META + "_id = " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.ID
 							+ " LEFT JOIN " + Region.TABLE_NAME + " ON " + CampaignFormData.REGION + "_id = " + Region.TABLE_NAME + "." + Region.ID
+							+ " LEFT JOIN " + Area.TABLE_NAME + " ON " + Region.AREA + "_id = " + Area.TABLE_NAME + "." + Area.ID
 							+ " LEFT JOIN " + District.TABLE_NAME + " ON " + CampaignFormData.DISTRICT + "_id = " + District.TABLE_NAME + "." + District.ID
+							+ " LEFT JOIN " + Community.TABLE_NAME + " ON " + CampaignFormData.COMMUNITY + "_id = " + Community.TABLE_NAME + "." + Community.ID
 							+ " LEFT JOIN " + Campaign.TABLE_NAME + " ON " + CampaignFormData.CAMPAIGN + "_id = " + Campaign.TABLE_NAME + "." + Campaign.ID
-							+ ", json_array_elements(" + CampaignFormData.FORM_VALUES + ") jsonData"
-							+ " WHERE " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID + " = '" + diagramSeries.getFormId() + "'"
+							+ ", json_array_elements(" + CampaignFormData.FORM_VALUES + ") as jsonData"
+							+ ", json_array_elements(" + CampaignFormMeta.CAMPAIGN_FORM_ELEMENTS + ") as jsonMeta"
+					+ " WHERE " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID + " = '" + diagramSeries.getFormId() + "'"
 							+ " AND jsonData->>'" + CampaignFormDataEntry.ID + "' = '" + diagramSeries.getFieldId() + "'"
 							+ " AND jsonData->>'" + CampaignFormDataEntry.VALUE + "' IS NOT NULL"
+							+ " AND jsonData->>'" + CampaignFormDataEntry.ID + "' = jsonMeta->>'" + CampaignFormElement.ID + "'"
+							+ areaFilter
 							+ regionFilter
 							+ districtFilter
-							+ campaignFilter
-							+ " GROUP BY " + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.UUID  + "," + CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID
+							+ campaignFilter 
+					+ " GROUP BY " 
+							+ CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.UUID  + "," 
+							+ CampaignFormMeta.TABLE_NAME + "." + CampaignFormMeta.FORM_ID
 							+ ", jsonData->>'" + CampaignFormDataEntry.ID + "'"
-							+ jurisdictionGrouping
-							+ ", " + Region.TABLE_NAME + "." + Region.UUID + ", " + Region.TABLE_NAME + "." + Region.NAME);
+							+ ", jsonMeta->>'" + CampaignFormElement.CAPTION + "'"
+							+ ", jsonMeta->>'" + CampaignFormElement.TYPE + "'"
+							+ jurisdictionGrouping);
 			//@formatter:on
 
 			@SuppressWarnings("unchecked")
@@ -340,25 +356,12 @@ public List<CampaignDiagramDataDto> getDiagramData(
 							(String) result[0],
 							(String) result[1],
 							(String) result[2],
-							(Object) result[3],
-							(String) result[4],
-							(String) result[5]))
+							(String) result[3],
+							(Object) result[4],
+							(String) result[5],
+							(String) result[6]))
 					.collect(Collectors.toList()));
 		}
-
-		// TODO: 21/08/2020 extract caption directly from json with query 
-		resultData.forEach(campaignDiagramDataDto -> {
-			final CampaignFormMetaDto formMeta = campaignFormMetaFacade.getCampaignFormMetaByUuid(campaignDiagramDataDto.getFormMetaUuid());
-			final String fieldId = campaignDiagramDataDto.getFieldId();
-			final Optional<CampaignFormElement> optionalCampaignFormElement =
-				formMeta.getCampaignFormElements().stream().filter(campaignFormElement -> campaignFormElement.getId().equals(fieldId)).findFirst();
-			if (optionalCampaignFormElement.isPresent()) {
-
-				campaignDiagramDataDto.setFieldCaption(optionalCampaignFormElement.get().getCaption());
-			} else {
-				campaignDiagramDataDto.setFieldCaption(fieldId);
-			}
-		});
 		return resultData;
 	}
 

sormas-backend/src/main/java/de/symeda/sormas/backend/region/RegionFacadeEjb.java

@@ -48,6 +48,7 @@
 import de.symeda.sormas.api.region.RegionReferenceDto;
 import de.symeda.sormas.api.utils.SortProperty;
 import de.symeda.sormas.api.utils.ValidationRuntimeException;
+import de.symeda.sormas.backend.common.InfrastructureAdo;
 import de.symeda.sormas.backend.facility.Facility;
 import de.symeda.sormas.backend.infrastructure.PointOfEntry;
 import de.symeda.sormas.backend.infrastructure.PopulationDataFacadeEjb.PopulationDataFacadeEjbLocal;
@@ -74,6 +75,17 @@ public class RegionFacadeEjb implements RegionFacade {
 	@EJB
 	private AreaService areaService;
 
+	@Override
+	public List<RegionReferenceDto> getAllActiveByArea(String areaUuid) {
+		CriteriaBuilder cb = em.getCriteriaBuilder();
+		CriteriaQuery<Region> cq = cb.createQuery(Region.class);
+		Root<Region> root = cq.from(Region.class);
+		cq.where(cb.and(cb.isFalse(root.get(InfrastructureAdo.ARCHIVED)), cb.equal(root.get(Region.AREA).get(Area.UUID), areaUuid)));
+		cq.orderBy(cb.asc(root.get(Region.NAME)));
+
+		return em.createQuery(cq).getResultList().stream().map(f -> toReferenceDto(f)).collect(Collectors.toList());
+	}
+
 	@Override
 	public List<RegionReferenceDto> getAllActiveAsReference() {
 		return regionService.getAllActive(Region.NAME, true).stream().map(f -> toReferenceDto(f)).collect(Collectors.toList());

sormas-backend/src/main/resources/sql/sormas_schema.sql

@@ -5254,4 +5254,13 @@ ALTER TABLE contact_history ADD COLUMN quarantineofficialordersentdate timestamp
 
 INSERT INTO schema_version (version_number, comment) VALUES (249, 'Add "Official order sent" and corresponding date to cases and contacts #2847');
 
+-- 2020-07-29 Campaign diagram visualisation refinement
+
+ALTER TABLE campaignformmeta ALTER COLUMN campaignFormElements TYPE json USING campaignFormElements::json;
+ALTER TABLE campaignformmeta ALTER COLUMN campaignFormTranslations TYPE json USING campaignFormTranslations::json;
+ALTER TABLE campaignformmeta_history ADD COLUMN campaignFormElements json;
+ALTER TABLE campaignformmeta_history ADD COLUMN campaignFormTranslations json;
+
+INSERT INTO schema_version (version_number, comment) VALUES (250, 'Campaign diagram visualization refinement #2753');
+
 -- *** Insert new sql commands BEFORE this line ***

sormas-ui/src/main/java/de/symeda/sormas/ui/campaign/campaigndata/CampaignDataView.java

@@ -15,7 +15,6 @@
 
 package de.symeda.sormas.ui.campaign.campaigndata;
 
-import static com.vaadin.navigator.ViewChangeListener.ViewChangeEvent;
 import static de.symeda.sormas.ui.utils.FilteredGrid.EDIT_BTN_ID;
 
 import java.util.List;
@@ -24,6 +23,7 @@
 import org.vaadin.hene.popupbutton.PopupButton;
 
 import com.vaadin.icons.VaadinIcons;
+import com.vaadin.navigator.ViewChangeListener.ViewChangeEvent;
 import com.vaadin.server.StreamResource;
 import com.vaadin.ui.Alignment;
 import com.vaadin.ui.Button;
@@ -94,14 +94,7 @@ public CampaignDataView() {
 
 		filterForm.getField(CampaignFormDataCriteria.CAMPAIGN_FORM_META).addValueChangeListener(e -> {
 			Object value = e.getProperty().getValue();
-			if (value == null) {
-				campaignFormElementImportance.setVisible(false);
-			} else {
-				campaignFormElementImportance.setVisible(true);
-				if (campaignFormElementImportance.getValue() == null) {
-					campaignFormElementImportance.setValue(CampaignFormElementImportance.ALL);
-				}
-			}
+			campaignFormElementImportance.setVisible(value != null);
 		});
 
 		campaignFormElementImportance.addValueChangeListener(e -> {
@@ -174,6 +167,7 @@ private void createImportanceFilterSwitch() {
 		campaignFormElementImportance
 			.setItemCaption(CampaignFormElementImportance.ALL, I18nProperties.getEnumCaption(CampaignFormElementImportance.ALL));
 
+		campaignFormElementImportance.setValue(CampaignFormElementImportance.IMPORTANT);
 		campaignFormElementImportance.setVisible(false);
 	}
 
@@ -247,7 +241,11 @@ public void enter(ViewChangeEvent event) {
 			params = params.substring(1);
 			criteria.fromUrlParams(params);
 		}
+
+		applyingCriteria = true;
 		filterForm.setValue(criteria);
+		applyingCriteria = false;
+
 		grid.reload();
 
 		super.enter(event);

sormas-ui/src/main/java/de/symeda/sormas/ui/configuration/infrastructure/RegionEditForm.java

@@ -81,9 +81,10 @@ protected void addFields() {
 
 		area.addItems(FacadeProvider.getAreaFacade().getAllActiveAsReference());
 
-		if (!create) {
-			area.setEnabled(false);
-		}
+		// area can always be changed, as it's not directly use for data references of other entities (e.g. case)
+//		if (!create) {
+//			area.setEnabled(false);
+//		}
 	}
 
 	@Override

sormas-ui/src/main/java/de/symeda/sormas/ui/dashboard/campaigns/CampaignDashboardDiagramComponent.java

@@ -6,10 +6,10 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
-import com.vaadin.ui.Alignment;
 import com.vaadin.ui.HorizontalLayout;
-import com.vaadin.ui.Label;
 import com.vaadin.ui.VerticalLayout;
 
 import de.symeda.sormas.api.campaign.diagram.CampaignDiagramDataDto;
@@ -39,14 +39,6 @@ public CampaignDashboardDiagramComponent(CampaignDiagramDefinitionDto diagramDef
 		headerLayout.setSpacing(true);
 		CssStyles.style(headerLayout, CssStyles.VSPACE_4);
 
-		Label headerLabel = new Label(diagramDefinition.getDiagramCaption());
-		headerLabel.setSizeUndefined();
-		CssStyles.style(headerLabel, CssStyles.H2, CssStyles.VSPACE_4, CssStyles.VSPACE_TOP_NONE);
-
-		headerLayout.addComponent(headerLabel);
-		headerLayout.setComponentAlignment(headerLabel, Alignment.BOTTOM_LEFT);
-		headerLayout.setExpandRatio(headerLabel, 1);
-
 		addComponent(headerLayout);
 
 		setWidth(100, Unit.PERCENTAGE);
@@ -62,56 +54,76 @@ public CampaignDashboardDiagramComponent(CampaignDiagramDefinitionDto diagramDef
 				axisCaptions.put(diagramData.getGroupingKey(), diagramData.getGroupingCaption());
 			}
 
-			// TODO key probably needs to be combination of form and field id
-			String seriesKey = diagramData.getFieldId();
+			String seriesKey = diagramData.getFormId() + diagramData.getFieldId();
 			if (!diagramDataBySeriesAndXAxis.containsKey(seriesKey)) {
-				diagramDataBySeriesAndXAxis.put(seriesKey, new HashMap<Object, CampaignDiagramDataDto>());
+				diagramDataBySeriesAndXAxis.put(seriesKey, new HashMap<>());
+			}
+			Map<Object, CampaignDiagramDataDto> objectCampaignDiagramDataDtoMap = diagramDataBySeriesAndXAxis.get(seriesKey);
+			if (objectCampaignDiagramDataDtoMap.containsKey(diagramData.getGroupingKey())) {
+				throw new RuntimeException("Campaign diagram data map already contains grouping");
 			}
-			// TODO throw exception when entry already exists
-			diagramDataBySeriesAndXAxis.get(seriesKey).put(diagramData.getGroupingKey(), diagramData);
+			objectCampaignDiagramDataDtoMap.put(diagramData.getGroupingKey(), diagramData);
 		}
 
-		buildDiagramChart();
+		buildDiagramChart(diagramDefinition.getDiagramCaption());
 	}
 
-	private void buildDiagramChart() {
+	private void buildDiagramChart(String title) {
 		final StringBuilder hcjs = new StringBuilder();
 
 		//@formatter:off
 		hcjs.append("var options = {"
 				+ "chart:{ "
 				+ " type: 'column', "
-				+ " backgroundColor: 'transparent' "
+				+ " backgroundColor: 'transparent', "
+				+ " borderRadius: '1', "
+				+ " borderWidth: '1', "
+				+ " spacing: [20, 20, 20, 20], "
 				+ "},"
 				+ "credits:{ enabled: false },"
 				+ "exporting:{ "
 				+ " enabled: true,"
 				+ " buttons:{ contextButton:{ theme:{ fill: 'transparent' } } }"
 				+ "},"
-				+ "title:{ text: '' },");
+				+ "legend: { backgroundColor: 'transparent', margin: 30 },"
+				+ "colors: ['#FF0000','#6691C4','#ffba08','#519e8a','#ed254e','#39a0ed','#FF8C00','#344055','#D36135','#82d173'],"
+				+ "title:{ text: '" + title + "'},");
 		//@formatter:on
 
-		hcjs.append("xAxis: { categories: [");
+		Map<String, Long> stackMap = diagramDefinition.getCampaignDiagramSeriesList()
+			.stream()
+			.filter(campaignDiagramSeries -> campaignDiagramSeries.getStack() != null)
+			.map(campaignDiagramSeries -> campaignDiagramSeries.getStack())
+			.collect(Collectors.groupingBy(Function.identity(), Collectors.counting()));
+
+		hcjs.append("xAxis: {");
+		if (stackMap.size() > 1) {
+			hcjs.append("opposite: true,");
+		}
+		hcjs.append("categories: [");
 		for (Object axisKey : axisKeys) {
 			hcjs.append("'").append(axisCaptions.get(axisKey)).append("',");
 		}
 		hcjs.append("]},");
 
 		//@formatter:off
-		hcjs.append("yAxis: { min: 0, title: { text: ''}},");
+		hcjs.append("yAxis: { min: 0, title: { text: ''}");
+		if (stackMap.size() > 1) {
+			hcjs.append(
+					", stackLabels: {enabled: true,verticalAlign: 'bottom',crop: false,overflow: 'none',y: 20,formatter: function() {  return this.stack;},style: {  color: 'grey'}}");
+		}
+		hcjs.append("},");
 		//@formatter:on
 
 		// series
-		if (diagramDefinition.getCampaignDiagramSeriesList()
-			.stream()
-			.filter(campaignDiagramSeries -> campaignDiagramSeries.getStack() != null)
-			.findAny()
-			.isPresent()) {
-			hcjs.append("plotOptions: {\n" + "    column: {\n" + "      stacking: 'normal'\n" + "    }\n" + "  },");
+
+		if (stackMap.size() > 0) {
+			hcjs.append("plotOptions: {column: { stacking: 'normal'}},");
 		}
+
 		hcjs.append("series: [");
 		for (CampaignDiagramSeries series : diagramDefinition.getCampaignDiagramSeriesList()) {
-			String seriesKey = series.getFieldId();
+			String seriesKey = series.getFormId() + series.getFieldId();
 			if (!diagramDataBySeriesAndXAxis.containsKey(seriesKey))
 				continue;