[DROOLS-4647][DROOLS-4701][DROOLS-4732] -Update History (undo & redo actions) to support Background grid + import/export background

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-api/src/main/java/org/drools/workbench/screens/scenariosimulation/service/ImportExportService.java

@@ -15,30 +15,31 @@
  */
 package org.drools.workbench.screens.scenariosimulation.service;
 
-import org.drools.scenariosimulation.api.model.Simulation;
+import org.drools.scenariosimulation.api.model.AbstractScesimData;
+import org.drools.scenariosimulation.api.model.AbstractScesimModel;
 import org.jboss.errai.bus.server.annotations.Remote;
 
 /**
- * This interface define the service to export and import data from a scenario
+ * This interface define the service to export and import data from a <code>AbstractScesimModel</code>
  */
 @Remote
 public interface ImportExportService {
 
     /**
-     * This method export the given simulation to the requested type
+     * This method export the given <code>AbstractScesimModel</code> to the requested type
      * @param type
-     * @param simulation
+     * @param scesimModel
      * @return
      */
-    Object exportSimulation(ImportExportType type, Simulation simulation);
+    Object exportScesimModel(ImportExportType type, AbstractScesimModel<? extends AbstractScesimData> scesimModel);
 
     /**
-     * This method parse the raw value and return a new simulation. The originalSimulation can be used to retrieve
+     * This method parse the raw value and return a new <code>AbstractScesimModel</code>. The <b>originalSimulation</b> can be used to retrieve
      * some metadata not available in the export (i.e. FactMapping)
      * @param type
      * @param raw
-     * @param originalSimulation
+     * @param originalScesimModel
      * @return
      */
-    Simulation importSimulation(ImportExportType type, Object raw, Simulation originalSimulation);
+    <T extends AbstractScesimData> AbstractScesimModel<T> importScesimModel(ImportExportType type, Object raw, AbstractScesimModel<T> originalScesimModel);
 }

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/main/java/org/drools/workbench/screens/scenariosimulation/backend/server/ImportExportServiceImpl.java

@@ -18,7 +18,8 @@
 
 import javax.enterprise.context.ApplicationScoped;
 
-import org.drools.scenariosimulation.api.model.Simulation;
+import org.drools.scenariosimulation.api.model.AbstractScesimData;
+import org.drools.scenariosimulation.api.model.AbstractScesimModel;
 import org.drools.workbench.screens.scenariosimulation.backend.server.importexport.ScenarioCsvImportExport;
 import org.drools.workbench.screens.scenariosimulation.service.ImportExportService;
 import org.drools.workbench.screens.scenariosimulation.service.ImportExportType;
@@ -32,11 +33,11 @@ public class ImportExportServiceImpl implements ImportExportService {
     protected ScenarioCsvImportExport scenarioCsvImportExport = new ScenarioCsvImportExport();
 
     @Override
-    public Object exportSimulation(ImportExportType type, Simulation simulation) {
+    public Object exportScesimModel(ImportExportType type, AbstractScesimModel<? extends AbstractScesimData> scesimModel) {
         try {
             switch (type) {
                 case CSV:
-                    return scenarioCsvImportExport.exportData(simulation);
+                    return scenarioCsvImportExport.exportData(scesimModel);
                 default:
                     throw new IllegalArgumentException("Impossible to parse " + type);
             }
@@ -46,11 +47,11 @@ public Object exportSimulation(ImportExportType type, Simulation simulation) {
     }
 
     @Override
-    public Simulation importSimulation(ImportExportType type, Object raw, Simulation originalSimulation) {
+    public <T extends AbstractScesimData> AbstractScesimModel<T> importScesimModel(ImportExportType type, Object raw, AbstractScesimModel<T> originalScesimModel) {
         try {
             switch (type) {
                 case CSV:
-                    return scenarioCsvImportExport.importData((String) raw, originalSimulation);
+                    return scenarioCsvImportExport.importData((String) raw, originalScesimModel);
                 default:
                     throw new IllegalArgumentException("Impossible to parse " + type);
             }

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/main/java/org/drools/workbench/screens/scenariosimulation/backend/server/importexport/ScenarioCsvImportExport.java

@@ -26,28 +26,28 @@
 import org.apache.commons.csv.CSVParser;
 import org.apache.commons.csv.CSVPrinter;
 import org.apache.commons.csv.CSVRecord;
+import org.drools.scenariosimulation.api.model.AbstractScesimData;
+import org.drools.scenariosimulation.api.model.AbstractScesimModel;
 import org.drools.scenariosimulation.api.model.FactMapping;
 import org.drools.scenariosimulation.api.model.FactMappingType;
 import org.drools.scenariosimulation.api.model.FactMappingValue;
-import org.drools.scenariosimulation.api.model.Scenario;
-import org.drools.scenariosimulation.api.model.Simulation;
 
 public class ScenarioCsvImportExport {
 
     public static final int HEADER_SIZE = 3;
 
-    public String exportData(Simulation simulation) throws IOException {
+    public String exportData(AbstractScesimModel<? extends AbstractScesimData> scesimModel) throws IOException {
         StringBuilder stringBuilder = new StringBuilder();
-        List<FactMapping> factMappings = simulation.getScesimModelDescriptor().getUnmodifiableFactMappings();
+        List<FactMapping> factMappings = scesimModel.getScesimModelDescriptor().getUnmodifiableFactMappings();
 
         CSVPrinter printer = new CSVPrinter(stringBuilder, CSVFormat.DEFAULT);
 
         generateHeader(factMappings, printer);
 
-        for (Scenario scenario : simulation.getUnmodifiableData()) {
+        for (AbstractScesimData scesimData : scesimModel.getUnmodifiableData()) {
             List<Object> values = new ArrayList<>();
             for (FactMapping factMapping : factMappings) {
-                Optional<FactMappingValue> factMappingValue = scenario.getFactMappingValue(factMapping.getFactIdentifier(),
+                Optional<FactMappingValue> factMappingValue = scesimData.getFactMappingValue(factMapping.getFactIdentifier(),
                                                                                            factMapping.getExpressionIdentifier());
                 values.add(factMappingValue.map(FactMappingValue::getRawValue).orElse(""));
             }
@@ -59,11 +59,11 @@ public String exportData(Simulation simulation) throws IOException {
         return stringBuilder.toString();
     }
 
-    public Simulation importData(String raw, Simulation originalSimulation) throws IOException {
+    public <T extends AbstractScesimData> AbstractScesimModel<T> importData(String raw, AbstractScesimModel<T> originalScesimModel) throws IOException {
 
         CSVParser csvParser = CSVFormat.DEFAULT.parse(new StringReader(raw));
 
-        Simulation toReturn = originalSimulation.cloneModel();
+        AbstractScesimModel<T> toReturn = originalScesimModel.cloneModel();
         toReturn.clearDatas();
 
         List<FactMapping> factMappings = toReturn.getScesimModelDescriptor().getUnmodifiableFactMappings();
@@ -75,14 +75,14 @@ public Simulation importData(String raw, Simulation originalSimulation) throws I
         csvRecords = csvRecords.subList(HEADER_SIZE, csvRecords.size());
 
         for (CSVRecord csvRecord : csvRecords) {
-            Scenario scenarioToFill = toReturn.addData();
+            T scesimDataToFill = toReturn.addData();
             if (csvRecord.size() != factMappings.size()) {
                 throw new IllegalArgumentException("Malformed row " + csvRecord);
             }
             for (int i = 0; i < factMappings.size(); i += 1) {
                 FactMapping factMapping = factMappings.get(i);
                 String valueToImport = "".equals(csvRecord.get(i)) ? null : csvRecord.get(i);
-                scenarioToFill.addMappingValue(factMapping.getFactIdentifier(),
+                scesimDataToFill.addMappingValue(factMapping.getFactIdentifier(),
                                                factMapping.getExpressionIdentifier(),
                                                valueToImport);
             }

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/main/java/org/drools/workbench/screens/scenariosimulation/backend/server/util/DMNSimulationSettingsCreationStrategy.java

@@ -58,6 +58,8 @@ public Simulation createSimulation(Path context, String dmnFilePath) {
         final FactModelTuple factModelTuple = getFactModelTuple(context, dmnFilePath);
         Simulation toReturn = new Simulation();
         ScesimModelDescriptor simulationDescriptor = toReturn.getScesimModelDescriptor();
+        simulationDescriptor.addFactMapping(FactIdentifier.INDEX.getName(), FactIdentifier.INDEX, ExpressionIdentifier.INDEX);
+        simulationDescriptor.addFactMapping(FactIdentifier.DESCRIPTION.getName(), FactIdentifier.DESCRIPTION, ExpressionIdentifier.DESCRIPTION);
         ScenarioWithIndex scenarioWithIndex = createScesimDataWithIndex(toReturn, simulationDescriptor, ScenarioWithIndex::new);
 
         AtomicInteger id = new AtomicInteger(1);

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/main/java/org/drools/workbench/screens/scenariosimulation/backend/server/util/RULESimulationSettingsCreationStrategy.java

@@ -17,6 +17,8 @@
 
 import javax.enterprise.context.ApplicationScoped;
 
+import org.drools.scenariosimulation.api.model.ExpressionIdentifier;
+import org.drools.scenariosimulation.api.model.FactIdentifier;
 import org.drools.scenariosimulation.api.model.ScenarioSimulationModel;
 import org.drools.scenariosimulation.api.model.ScenarioWithIndex;
 import org.drools.scenariosimulation.api.model.ScesimModelDescriptor;
@@ -34,6 +36,8 @@ public class RULESimulationSettingsCreationStrategy implements SimulationSetting
     public Simulation createSimulation(Path context, String value) {
         Simulation toReturn = new Simulation();
         ScesimModelDescriptor simulationDescriptor = toReturn.getScesimModelDescriptor();
+        simulationDescriptor.addFactMapping(FactIdentifier.INDEX.getName(), FactIdentifier.INDEX, ExpressionIdentifier.INDEX);
+        simulationDescriptor.addFactMapping(FactIdentifier.DESCRIPTION.getName(), FactIdentifier.DESCRIPTION, ExpressionIdentifier.DESCRIPTION);
         ScenarioWithIndex scenarioWithIndex = createScesimDataWithIndex(toReturn, simulationDescriptor, ScenarioWithIndex::new);
 
         // Add GIVEN Fact

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/main/java/org/drools/workbench/screens/scenariosimulation/backend/server/util/SimulationSettingsCreationStrategy.java

@@ -44,8 +44,6 @@ public interface SimulationSettingsCreationStrategy {
     Settings createSettings(Path context, String value);
 
     default <T extends AbstractScesimData, E extends ScesimDataWithIndex<T>> E createScesimDataWithIndex(AbstractScesimModel<T> abstractScesimModel, ScesimModelDescriptor simulationDescriptor, BiFunction<Integer, T, E> producer) {
-        simulationDescriptor.addFactMapping(FactIdentifier.INDEX.getName(), FactIdentifier.INDEX, ExpressionIdentifier.INDEX);
-        simulationDescriptor.addFactMapping(FactIdentifier.DESCRIPTION.getName(), FactIdentifier.DESCRIPTION, ExpressionIdentifier.DESCRIPTION);
         T scenario = abstractScesimModel.addData();
         scenario.setDescription(null);
         int index = abstractScesimModel.getUnmodifiableData().indexOf(scenario) + 1;

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/test/java/org/drools/workbench/screens/scenariosimulation/backend/server/ImportExportServiceImplTest.java

@@ -39,12 +39,12 @@
 public class ImportExportServiceImplTest {
 
     @Mock
-    ScenarioCsvImportExport scenarioCsvImportExportMock;
+    private ScenarioCsvImportExport scenarioCsvImportExportMock;
 
     @Mock
-    Simulation simulationMock;
+    private Simulation simulationMock;
 
-    ImportExportServiceImpl importExportService;
+    private ImportExportServiceImpl importExportService;
 
     @Before
     public void setup() {
@@ -56,25 +56,25 @@ public void setup() {
     }
 
     @Test
-    public void exportSimulation() throws IOException {
-        importExportService.exportSimulation(ImportExportType.CSV, simulationMock);
+    public void exportScesimModel() throws IOException {
+        importExportService.exportScesimModel(ImportExportType.CSV, simulationMock);
         verify(scenarioCsvImportExportMock, times(1)).exportData(eq(simulationMock));
 
         when(scenarioCsvImportExportMock.exportData(any())).thenThrow(new IllegalStateException());
         assertThatThrownBy(() -> importExportService
-                .exportSimulation(ImportExportType.CSV, simulationMock))
+                .exportScesimModel(ImportExportType.CSV, simulationMock))
                 .isInstanceOf(GenericPortableException.class);
     }
 
     @Test
-    public void importSimulation() throws IOException {
+    public void importScesimModel() throws IOException {
         String raw = "";
-        importExportService.importSimulation(ImportExportType.CSV, raw, simulationMock);
+        importExportService.importScesimModel(ImportExportType.CSV, raw, simulationMock);
         verify(scenarioCsvImportExportMock, times(1)).importData(eq(raw), eq(simulationMock));
 
         when(scenarioCsvImportExportMock.importData(anyString(), any())).thenThrow(new IllegalStateException());
         assertThatThrownBy(() -> importExportService
-                .importSimulation(ImportExportType.CSV, raw, simulationMock))
+                .importScesimModel(ImportExportType.CSV, raw, simulationMock))
                 .isInstanceOf(GenericPortableException.class);
     }
 }

drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-backend/src/test/java/org/drools/workbench/screens/scenariosimulation/backend/server/importexport/ScenarioCsvImportExportTest.java

@@ -21,6 +21,7 @@
 
 import org.apache.commons.csv.CSVFormat;
 import org.apache.commons.csv.CSVPrinter;
+import org.drools.scenariosimulation.api.model.AbstractScesimModel;
 import org.drools.scenariosimulation.api.model.ExpressionIdentifier;
 import org.drools.scenariosimulation.api.model.FactIdentifier;
 import org.drools.scenariosimulation.api.model.FactMapping;
@@ -38,14 +39,14 @@
 
 public class ScenarioCsvImportExportTest {
 
-    static String instanceName = "instanceName";
-    static String propertyName = "propertyName";
+    private static String instanceName = "instanceName";
+    private static String propertyName = "propertyName";
 
-    CSVPrinter printer;
+    private CSVPrinter printer;
 
-    ScenarioCsvImportExport scenarioCsvImportExport;
+    private ScenarioCsvImportExport scenarioCsvImportExport;
 
-    StringBuilder output;
+    private StringBuilder output;
 
     @Before
     public void setup() throws IOException {
@@ -76,13 +77,13 @@ public void importData() throws IOException {
                 "Index,Description,property1,property2,property3\r\n" +
                 "1,My Scenario,value1,value2,";
 
-        Simulation simulation = scenarioCsvImportExport.importData(rawCSV, originalSimulation);
+        AbstractScesimModel retrieved = scenarioCsvImportExport.importData(rawCSV, originalSimulation);
 
-        assertEquals(1, simulation.getUnmodifiableData().size());
+        assertEquals(1, retrieved.getUnmodifiableData().size());
 
-        assertEquals("value1", simulation.getDataByIndex(0).getFactMappingValue(simulation.getScesimModelDescriptor().getFactMappingByIndex(2)).get().getRawValue());
-        assertEquals("value2", simulation.getDataByIndex(0).getFactMappingValue(simulation.getScesimModelDescriptor().getFactMappingByIndex(3)).get().getRawValue());
-        assertNull(simulation.getDataByIndex(0).getFactMappingValue(simulation.getScesimModelDescriptor().getFactMappingByIndex(4)).get().getRawValue());
+        assertEquals("value1", retrieved.getDataByIndex(0).getFactMappingValue(retrieved.getScesimModelDescriptor().getFactMappingByIndex(2)).get().getRawValue());
+        assertEquals("value2", retrieved.getDataByIndex(0).getFactMappingValue(retrieved.getScesimModelDescriptor().getFactMappingByIndex(3)).get().getRawValue());
+        assertNull(retrieved.getDataByIndex(0).getFactMappingValue(retrieved.getScesimModelDescriptor().getFactMappingByIndex(4)).get().getRawValue());
 
         assertThatThrownBy(() -> scenarioCsvImportExport.importData("", originalSimulation))
                 .isInstanceOf(IllegalArgumentException.class)