[2137] Merge the two objective requirement creation tools

Bug: #2137
Signed-off-by: Guillaume Coutable <guillaume.coutable@obeo.fr>

Author: gcoutable

CHANGELOG.adoc

@@ -68,6 +68,7 @@ Stakeholders are by default represented with a dedicated graphical node connecte
 - https://github.com/eclipse-syson/syson/issues/2122[#2122] [diagrams] Leverage the latest change of the selection dialog to allow creating a `Subject` graphical node without specialization.
 - https://github.com/eclipse-syson/syson/issues/2129[#2129] [diagrams] Leverage the latest change of the selection dialog to allow creating a `FlowUsage` from a `ConnectionUsage` without selection a `PayloadFeature`
 - https://github.com/eclipse-syson/syson/issues/2105[#2105] [explorer] In the _Explorer_ view, `Expression` elements now display their full textual representation.
+- https://github.com/eclipse-syson/syson/issues/2137[#2137] [diagrams] Merge the two objective creation tools into a single tool, leveraging the updated selection dialog.
 
 === New features
 

backend/application/syson-application/src/test/java/org/eclipse/syson/application/controllers/diagrams/general/view/GVObjectiveDocumentationTests.java

@@ -55,7 +55,7 @@
 import reactor.test.StepVerifier;
 
 /**
- * Objective compartment related tests.
+ * Objective documentation compartment related tests.
  *
  * @author arichard
  */

backend/application/syson-application/src/test/java/org/eclipse/syson/application/controllers/diagrams/general/view/GVObjectiveTests.java

@@ -12,14 +12,19 @@
  *******************************************************************************/
 package org.eclipse.syson.diagram.common.view.tools;
 
+import org.eclipse.sirius.components.view.diagram.SelectionDialogDescription;
 import org.eclipse.syson.diagram.common.view.services.ViewCreateService;
+import org.eclipse.syson.diagram.services.aql.DiagramQueryAQLService;
 import org.eclipse.syson.sysml.RequirementUsage;
+import org.eclipse.syson.util.AQLConstants;
 import org.eclipse.syson.util.ServiceMethod;
 
 /**
  * Node tool provider for objective compartment in the element that need such compartment.
+ *
  * <p>
- * This tool creates a new {@link RequirementUsage} and sets it as the objective of the containing element.
+ * This tool opens a selection dialog to create a {@link RequirementUsage} that serves as an objective.
+ * The user can choose to create it as a standalone element or select an existing requirement to be set as its type or subset.
  * </p>
  *
  * @author Jerome Gout
@@ -28,7 +33,29 @@ public class ObjectiveRequirementCompartmentNodeToolProvider extends AbstractCom
 
     @Override
     protected String getServiceCallExpression() {
-        return ServiceMethod.of1(ViewCreateService::createRequirementUsageAsObjectiveRequirement).aqlSelf("null");
+        return ServiceMethod.of1(ViewCreateService::createRequirementUsageAsObjectiveRequirement).aqlSelf("selectedObject");
+    }
+
+    @Override
+    protected SelectionDialogDescription getSelectionDialogDescription() {
+        var selectionDialogTree = this.diagramBuilderHelper.newSelectionDialogTreeDescription()
+                .elementsExpression(ServiceMethod.of0(DiagramQueryAQLService::getAllReachableRequirements).aqlSelf())
+                .build();
+        return this.diagramBuilderHelper.newSelectionDialogDescription()
+                .selectionDialogTreeDescription(selectionDialogTree)
+                .defaultTitleExpression(this.getNodeToolName())
+                .noSelectionTitleExpression(this.getNodeToolName())
+                .withSelectionTitleExpression(this.getNodeToolName())
+                .descriptionExpression("Create an objective:")
+                .noSelectionActionLabelExpression("Create a new objective")
+                .noSelectionActionDescriptionExpression("Create a new objective without specialization")
+                .withSelectionActionLabelExpression("Select an existing Element as objective")
+                .withSelectionActionDescriptionExpression("Create a new specialized objective")
+                .noSelectionActionStatusMessageExpression("It will create a new objective without specialization")
+                .selectionRequiredWithoutSelectionStatusMessageExpression("Select one Element to specialize the new objective")
+                .selectionRequiredWithSelectionStatusMessageExpression(AQLConstants.AQL + "'It will create an objective specialized with ' + selectedObjects->first().name")
+                .optional(true)
+                .build();
     }
 
     @Override

backend/application/syson-application/src/test/resources/scripts/database-content/GeneralView-IncludeUseCaseUsage.sql

@@ -26,7 +26,6 @@
 import org.eclipse.syson.diagram.common.view.nodes.AbstractCompartmentNodeDescriptionProvider;
 import org.eclipse.syson.diagram.common.view.tools.ObjectiveDocumentationNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementCompartmentNodeToolProvider;
-import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider;
 import org.eclipse.syson.diagram.services.aql.DiagramMutationAQLService;
 import org.eclipse.syson.sysml.SysmlPackage;
 import org.eclipse.syson.util.IDescriptionNameGenerator;
@@ -80,7 +79,6 @@ protected String getDropElementFromDiagramExpression() {
     protected List<INodeToolProvider> getItemCreationToolProviders() {
         List<INodeToolProvider> creationToolProviders = new ArrayList<>();
         creationToolProviders.add(new ObjectiveRequirementCompartmentNodeToolProvider());
-        creationToolProviders.add(new ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider());
         creationToolProviders.add(new ObjectiveDocumentationNodeToolProvider(SysmlPackage.eINSTANCE.getCaseDefinition_ObjectiveRequirement()));
         return creationToolProviders;
     }

backend/application/syson-application/src/test/resources/scripts/database-content/SysON-Studio.sql

@@ -26,7 +26,6 @@
 import org.eclipse.syson.diagram.common.view.nodes.AbstractCompartmentNodeDescriptionProvider;
 import org.eclipse.syson.diagram.common.view.tools.ObjectiveDocumentationNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementCompartmentNodeToolProvider;
-import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider;
 import org.eclipse.syson.diagram.services.aql.DiagramMutationAQLService;
 import org.eclipse.syson.sysml.SysmlPackage;
 import org.eclipse.syson.util.IDescriptionNameGenerator;
@@ -80,7 +79,6 @@ protected String getDropElementFromDiagramExpression() {
     protected List<INodeToolProvider> getItemCreationToolProviders() {
         List<INodeToolProvider> creationToolProviders = new ArrayList<>();
         creationToolProviders.add(new ObjectiveRequirementCompartmentNodeToolProvider());
-        creationToolProviders.add(new ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider());
         creationToolProviders.add(new ObjectiveDocumentationNodeToolProvider(SysmlPackage.eINSTANCE.getCaseUsage_ObjectiveRequirement()));
         return creationToolProviders;
     }

backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/tools/ObjectiveRequirementCompartmentNodeToolProvider.java

@@ -40,7 +40,6 @@
 import org.eclipse.syson.diagram.common.view.tools.JoinActionNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.MergeActionNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementCompartmentNodeToolProvider;
-import org.eclipse.syson.diagram.common.view.tools.ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.OccurrenceUsageSnapshotNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.OccurrenceUsageTimesliceNodeToolProvider;
 import org.eclipse.syson.diagram.common.view.tools.ParameterCompartmentNodeToolProvider;
@@ -249,7 +248,6 @@ public List<NodeToolSection> caseCaseDefinition(CaseDefinition object) {
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewSubjectNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewActorNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.createRequirementUsageAsObjectiveRequirementNodeTool());
-        this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool());
 
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.VIEW_AS,
                 new ViewNodeAsToolProvider(AQLUtils.aqlString(StandardDiagramsConstants.GV_QN), StandardDiagramsConstants.GV).create(this.cache));
@@ -278,7 +276,6 @@ public List<NodeToolSection> caseCaseUsage(CaseUsage object) {
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewSubjectNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewActorNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.createRequirementUsageAsObjectiveRequirementNodeTool());
-        this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, new SetAsCompositeToolProvider().create(this.cache));
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, new SetAsRefToolProvider().create(this.cache));
 
@@ -812,7 +809,6 @@ public List<NodeToolSection> caseUseCaseDefinition(UseCaseDefinition object) {
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewSubjectNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewActorNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.createRequirementUsageAsObjectiveRequirementNodeTool());
-        this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool());
 
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.VIEW_AS,
                 new ViewNodeAsToolProvider(AQLUtils.aqlString(StandardDiagramsConstants.GV_QN), StandardDiagramsConstants.GV).create(this.cache));
@@ -841,7 +837,6 @@ public List<NodeToolSection> caseUseCaseUsage(UseCaseUsage object) {
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewSubjectNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewActorNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.createRequirementUsageAsObjectiveRequirementNodeTool());
-        this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, new SetAsCompositeToolProvider().create(this.cache));
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, new SetAsRefToolProvider().create(this.cache));
 
@@ -862,7 +857,6 @@ public List<NodeToolSection> caseViewUsage(ViewUsage object) {
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewSubjectNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.STRUCTURE, this.createNewActorNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.createRequirementUsageAsObjectiveRequirementNodeTool());
-        this.toolDescriptionService.addNodeTool(sections, ToolConstants.REQUIREMENTS, this.creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool());
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.VIEW_AS,
                 new SetAsViewToolProvider(AQLUtils.aqlString(StandardDiagramsConstants.GV_QN), StandardDiagramsConstants.GV).create(this.cache));
         this.toolDescriptionService.addNodeTool(sections, ToolConstants.VIEW_AS,
@@ -934,11 +928,6 @@ private NodeTool createRequirementUsageAsObjectiveRequirementNodeTool() {
         return objectiveRequirementCompartmentNodeToolProvider.create(this.cache);
     }
 
-    private NodeTool creatRequirementUsageAsObjectiveWithBaseRequirementNodeTool() {
-        var objectiveRequirementWithBaseRequirementCompartmentNodeToolProvider = new ObjectiveRequirementWithBaseRequirementCompartmentNodeToolProvider();
-        return objectiveRequirementWithBaseRequirementCompartmentNodeToolProvider.create(this.cache);
-    }
-
     private NodeTool createPayloadNodeTool(EClass payloadType) {
         var payloadNodeToolProvider = new AcceptActionPayloadNodeToolProvider(payloadType, this.descriptionNameGenerator);
         return payloadNodeToolProvider.create(this.cache);