SORMAS-Foundation#3368 - add sub tab id to the CampaignDashboardElement

barnabartha · barnabartha · commit 6deed0e15cad · 2020-11-09T09:48:29.000+02:00
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/campaign/diagram/CampaignDashboardElement.java b/sormas-api/src/main/java/de/symeda/sormas/api/campaign/diagram/CampaignDashboardElement.java
@@ -1,18 +1,19 @@
 package de.symeda.sormas.api.campaign.diagram;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class CampaignDashboardElement implements Serializable {
 
 	public static String DIAGRAM_ID = "diagramId";
 	public static String TAB_ID = "tabId";
+	public static String SUB_TAB_ID = "subTabId";
 	public static String ORDER = "order";
 	public static String WIDTH = "width";
 	public static String HEIGHT = "height";
 
 	private String diagramId;
 	private String tabId;
+	private String subTabId;
 	private Integer order;
 	private Integer width;
 	private Integer height;
@@ -28,6 +29,11 @@ public CampaignDashboardElement(String diagramId, String tabId, Integer order, I
 		this.height = height;
 	}
 
+	public CampaignDashboardElement(String diagramId, String tabId, String subTabId, Integer order, Integer width, Integer height) {
+		this(diagramId, tabId, order, width, height);
+		this.subTabId = subTabId;
+	}
+
 	public String getDiagramId() {
 		return diagramId;
 	}
@@ -44,6 +50,14 @@ public void setTabId(String tabId) {
 		this.tabId = tabId;
 	}
 
+	public String getSubTabId() {
+		return subTabId;
+	}
+
+	public void setSubTabId(String subTabId) {
+		this.subTabId = subTabId;
+	}
+
 	public Integer getOrder() {
 		return order;
 	}
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/campaign/diagram/CampaignDiagramDefinitionDto.java b/sormas-api/src/main/java/de/symeda/sormas/api/campaign/diagram/CampaignDiagramDefinitionDto.java
@@ -1,6 +1,8 @@
 package de.symeda.sormas.api.campaign.diagram;
 
 import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.campaign.CampaignDto;
+import de.symeda.sormas.api.utils.DataHelper;
 
 import java.util.List;
 
@@ -13,6 +15,12 @@ public class CampaignDiagramDefinitionDto extends EntityDto {
 	private List<CampaignDiagramSeries> campaignSeriesTotal;
 	private boolean percentageDefault;
 
+	public static CampaignDiagramDefinitionDto build() {
+		CampaignDiagramDefinitionDto campaignDiagramDefinition = new CampaignDiagramDefinitionDto();
+		campaignDiagramDefinition.setUuid(DataHelper.createUuid());
+		return campaignDiagramDefinition;
+	}
+
 	public String getDiagramId() {
 		return diagramId;
 	}
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java b/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java
@@ -157,6 +157,7 @@ public interface Captions {
 	String campaignDashboardChartHeight = "campaignDashboardChartHeight";
 	String campaignDashboardChartWidth = "campaignDashboardChartWidth";
 	String campaignDashboardOrder = "campaignDashboardOrder";
+	String campaignDashboardSubTabName = "campaignDashboardSubTabName";
 	String campaignDashboardTabName = "campaignDashboardTabName";
 	String CampaignFormData_area = "CampaignFormData.area";
 	String CampaignFormData_campaign = "CampaignFormData.campaign";
diff --git a/sormas-api/src/main/resources/captions.properties b/sormas-api/src/main/resources/captions.properties
@@ -201,6 +201,7 @@ campaignAdditionalForm=Add form
 campaignAdditionalChart=Add chart
 campaignDashboardChart=Campaign data chart
 campaignDashboardTabName=Tab name
+campaignDashboardSubTabName=Sub-tab name
 campaignDashboardChartWidth=Width in %
 campaignDashboardChartHeight=Height in %
 campaignDashboardOrder=Order
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/campaign/CampaignFacadeEjb.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/campaign/CampaignFacadeEjb.java
@@ -5,7 +5,9 @@
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -200,9 +202,17 @@ public void validate(CampaignReferenceDto campaignReferenceDto) {
 		validate(getByUuid(campaignReferenceDto.getUuid()));
 	}
 
-	private void validate(CampaignDto campaignDto) {
+	protected void validate(CampaignDto campaignDto) {
 		final List<CampaignDashboardElement> campaignDashboardElements = campaignDto.getCampaignDashboardElements();
 		if (campaignDashboardElements != null) {
+
+            final Map<String, Boolean> oneSubTabIsNotNullOrEmptyMap = new HashMap<>();
+            campaignDashboardElements.stream().forEach(cde -> {
+                if (!oneSubTabIsNotNullOrEmptyMap.containsKey(cde.getTabId())){
+                    oneSubTabIsNotNullOrEmptyMap.put(cde.getTabId(), false);
+                }
+            });
+
 			for (CampaignDashboardElement cde : campaignDashboardElements) {
 				final String diagramId = cde.getDiagramId();
 				if (diagramId == null) {
@@ -212,8 +222,8 @@ private void validate(CampaignDto campaignDto) {
 							CampaignDashboardElement.DIAGRAM_ID,
 							campaignDto.getName()));
 				} else if (!campaignDiagramDefinitionFacade.exists(diagramId)) {
-						throw new ValidationRuntimeException(
-							I18nProperties.getValidationError(Validations.campaignDashboardChartIdDoesNotExist, diagramId, campaignDto.getName()));
+					throw new ValidationRuntimeException(
+						I18nProperties.getValidationError(Validations.campaignDashboardChartIdDoesNotExist, diagramId, campaignDto.getName()));
 				}
 
 				if (cde.getTabId() == null) {
@@ -222,6 +232,18 @@ private void validate(CampaignDto campaignDto) {
 							.getValidationError(Validations.campaignDashboardChartValueNull, CampaignDashboardElement.TAB_ID, campaignDto.getName()));
 				}
 
+				if (cde.getSubTabId() == null || cde.getSubTabId().isEmpty()) {
+					if (oneSubTabIsNotNullOrEmptyMap.get(cde.getTabId())) {
+						throw new ValidationRuntimeException(
+							I18nProperties.getValidationError(
+								Validations.campaignDashboardChartValueNull,
+								CampaignDashboardElement.SUB_TAB_ID,
+								campaignDto.getName()));
+					}
+				} else {
+                    oneSubTabIsNotNullOrEmptyMap.put(cde.getTabId(), true);
+				}
+
 				if (cde.getOrder() == null) {
 					throw new ValidationRuntimeException(
 						I18nProperties
@@ -292,6 +314,9 @@ public List<CampaignDashboardElement> getCampaignDashboardElements(String campai
 			if (cde.getTabId() == null) {
 				cde.setTabId(StringUtils.EMPTY);
 			}
+			if (cde.getSubTabId() == null) {
+				cde.setSubTabId(StringUtils.EMPTY);
+			}
 			if (cde.getOrder() == null) {
 				cde.setOrder(0);
 			}
diff --git a/sormas-backend/src/test/java/de/symeda/sormas/backend/TestDataCreator.java b/sormas-backend/src/test/java/de/symeda/sormas/backend/TestDataCreator.java
@@ -37,6 +37,8 @@
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
 import de.symeda.sormas.api.campaign.data.CampaignFormDataDto;
 import de.symeda.sormas.api.campaign.data.CampaignFormDataEntry;
+import de.symeda.sormas.api.campaign.diagram.CampaignDiagramDefinitionDto;
+import de.symeda.sormas.api.campaign.diagram.DiagramType;
 import de.symeda.sormas.api.campaign.form.CampaignFormMetaDto;
 import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.caze.CaseClassification;
@@ -975,6 +977,15 @@ public CampaignDto createCampaign(UserDto user) {
 		return campaign;
 	}
 
+	public CampaignDiagramDefinitionDto createCampaignDiagramDefinition(String diagramId, String diagramCaption){
+		CampaignDiagramDefinitionDto campaignDiagramDefinition = CampaignDiagramDefinitionDto.build();
+		campaignDiagramDefinition.setDiagramType(DiagramType.COLUMN);
+		campaignDiagramDefinition.setDiagramId(diagramId);
+		campaignDiagramDefinition.setDiagramCaption(diagramCaption);
+
+		return campaignDiagramDefinition;
+	}
+
 	public CampaignFormMetaDto createCampaignForm(CampaignDto campaign) throws IOException {
 
 		CampaignFormMetaDto campaignForm;
diff --git a/sormas-backend/src/test/java/de/symeda/sormas/backend/campaign/CampaignFacadeEjbTest.java b/sormas-backend/src/test/java/de/symeda/sormas/backend/campaign/CampaignFacadeEjbTest.java
@@ -1,21 +1,20 @@
 package de.symeda.sormas.backend.campaign;
 
+import java.util.ArrayList;
 import java.util.Date;
-import java.util.List;
 
-import de.symeda.sormas.backend.MockProducer;
 import org.junit.Assert;
 import org.junit.Test;
 
 import de.symeda.sormas.api.campaign.CampaignDto;
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
+import de.symeda.sormas.api.campaign.diagram.CampaignDashboardElement;
 import de.symeda.sormas.api.user.UserDto;
 import de.symeda.sormas.api.user.UserRole;
+import de.symeda.sormas.api.utils.ValidationRuntimeException;
 import de.symeda.sormas.backend.AbstractBeanTest;
 import de.symeda.sormas.backend.TestDataCreator;
 
-import static org.mockito.Mockito.when;
-
 public class CampaignFacadeEjbTest extends AbstractBeanTest {
 
 	public static final int ONE_DAY_IN_MILLIS = 24 * 60 * 60 * 1000;
@@ -38,4 +37,66 @@ public void testGetLastStartedCampaign() {
 		CampaignReferenceDto lastStartedCampaign = getCampaignFacade().getLastStartedCampaign();
 		Assert.assertEquals(campaign2.getUuid(), lastStartedCampaign.getUuid());
 	}
+
+	@Test
+	public void testCampaignDashboardElementsValidation() {
+
+		final TestDataCreator.RDCF rdcf = creator.createRDCF("Region", "District", "Community", "Facility");
+		final UserDto user = creator.createUser(rdcf, UserRole.SURVEILLANCE_SUPERVISOR);
+
+		final CampaignDto campaign = creator.createCampaign(user);
+		final ArrayList<CampaignDashboardElement> campaignDashboardElements = new ArrayList<>();
+		campaignDashboardElements.add(new CampaignDashboardElement("diagram1", "tab1", null, 1, 50, 50));
+		campaignDashboardElements.add(new CampaignDashboardElement("diagram2", "tab1", null, 1, 50, 50));
+		campaignDashboardElements.add(new CampaignDashboardElement("diagram3", "tab2", null, 1, 50, 50));
+		campaign.setCampaignDashboardElements(campaignDashboardElements);
+
+		getCampaignDiagramDefinitionFacade().save(creator.createCampaignDiagramDefinition("diagram1", "Diagram one"));
+		getCampaignDiagramDefinitionFacade().save(creator.createCampaignDiagramDefinition("diagram2", "Diagram two"));
+		getCampaignDiagramDefinitionFacade().save(creator.createCampaignDiagramDefinition("diagram3", "Diagram three"));
+
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.fail(e.getMessage());
+		}
+
+		campaign.getCampaignDashboardElements().get(0).setSubTabId("subTab1");
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.assertEquals("Campaign dashboard elements subTabId of campaign CampaignName are missing!", e.getMessage());
+		}
+
+		campaign.getCampaignDashboardElements().get(0).setSubTabId(null);
+		campaign.getCampaignDashboardElements().get(1).setSubTabId("subTab2");
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.assertEquals("Campaign dashboard elements subTabId of campaign CampaignName are missing!", e.getMessage());
+		}
+
+		campaign.getCampaignDashboardElements().get(0).setSubTabId("subTab1");
+		campaign.getCampaignDashboardElements().get(1).setSubTabId("subTab2");
+		campaign.getCampaignDashboardElements().get(2).setSubTabId("subTab3");
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.fail(e.getMessage());
+		}
+
+		campaign.getCampaignDashboardElements().get(2).setSubTabId(null);
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.fail(e.getMessage());
+		}
+
+		campaign.getCampaignDashboardElements().get(0).setDiagramId("nonExistingDiagramId");
+		try {
+			((CampaignFacadeEjb.CampaignFacadeEjbLocal) getCampaignFacade()).validate(campaign);
+		} catch (ValidationRuntimeException e) {
+			Assert.assertEquals("Diagram nonExistingDiagramId from campaign CampaignName does not exist!", e.getMessage());
+		}
+	}
 }
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/campaign/campaigns/CampaignDashboardElementsGridComponent.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/campaign/campaigns/CampaignDashboardElementsGridComponent.java
@@ -77,6 +77,24 @@ protected Binder<CampaignDashboardElement> addColumnsBinder(List<CampaignDashboa
 				.setCaption(I18nProperties.getCaption(Captions.campaignDashboardTabName));
 		tabIdColumn.setEditorBinding(tabIdBind);
 
+		final List<String> existingSubTabIds = allElements.stream()
+			.map(campaignDiagramDefinitionDto -> campaignDiagramDefinitionDto.getSubTabId())
+			.filter(s -> StringUtils.isNotEmpty(s))
+			.distinct()
+			.collect(Collectors.toList());
+		final ComboBox<String> subTabIdCombo = new ComboBox<>(Captions.campaignDashboardSubTabName, existingSubTabIds);
+
+		subTabIdCombo.setEmptySelectionAllowed(true);
+		subTabIdCombo.setTextInputAllowed(true);
+		subTabIdCombo.setNewItemProvider((ComboBox.NewItemProvider<String>) s -> Optional.of(s));
+
+		final Binder.Binding<CampaignDashboardElement, String> subTabIdBind =
+			binder.bind(subTabIdCombo, CampaignDashboardElement::getSubTabId, CampaignDashboardElement::setSubTabId);
+		final Grid.Column<CampaignDashboardElement, String> subTabIdColumn =
+			grid.addColumn(campaignDashboardElement -> campaignDashboardElement.getSubTabId())
+				.setCaption(I18nProperties.getCaption(Captions.campaignDashboardSubTabName));
+		subTabIdColumn.setEditorBinding(subTabIdBind);
+
 		TextField width = new TextField(Captions.campaignDashboardChartWidth);
 		Binder.Binding<CampaignDashboardElement, String> widthBind = binder.forField(width)
 			.withValidator(percentValidator(), I18nProperties.getValidationError(Validations.campaignDashboardChartPercentage))
