[960] Display possible 'stakeholder' PartUsages in a tree

In the General View diagram, the creation tool for StakeholderParameter
now shows possible candidate PartUsages in a tree instead of a flat
list.

Bug: #960
Signed-off-by: Florent Latombe <florent.latombe@obeo.fr>

Author: flatombe

CHANGELOG.adoc

@@ -47,6 +47,7 @@ The changes are:
 - https://github.com/eclipse-syson/syson/issues/946[#946] [libraries] All standard libraries have been updated to comply with the SysML Beta 2.3 specification.
 - https://github.com/eclipse-syson/syson/issues/982[#982] [metamodel] `Membership#isDistinguishableFrom` derived attribute has been implemented.
 - https://github.com/eclipse-syson/syson/issues/992[#992] [export] Implement SysML export of `ConcernDefinition`, `ConcernUsage` and `StakeholderMembership`
+- https://github.com/eclipse-syson/syson/issues/960[#960] [general-view] In the selection dialog of the creation tool for 'StakeholderParameter', display possible PartUsage candidates in a tree instead of a list.
 
 === New features
 

backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/services/ViewToolService.java

@@ -14,7 +14,9 @@
 
 import java.text.MessageFormat;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.HashSet;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -23,8 +25,8 @@
 import java.util.Set;
 import java.util.stream.Stream;
 
-import org.eclipse.emf.common.util.TreeIterator;
 import org.eclipse.emf.ecore.EClass;
+import org.eclipse.emf.ecore.EClassifier;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.emf.edit.domain.EditingDomain;
@@ -1129,11 +1131,11 @@ public List<Resource> getNamespaceImportSelectionDialogElements(IEditingContext
                 .map(IEMFEditingContext.class::cast)
                 .map(IEMFEditingContext::getDomain)
                 .map(EditingDomain::getResourceSet);
-        var resouces = optionalResourceSet.map(resourceSet -> resourceSet.getResources().stream()
-                        .filter(this::containsPackage)
+        var resources = optionalResourceSet.map(resourceSet -> resourceSet.getResources().stream()
+                .filter(resource -> containsDirectlyOrIndirectlyInstancesOf(resource, SysmlPackage.eINSTANCE.getPackage()))
                         .toList())
                 .orElseGet(ArrayList::new);
-        return resouces.stream().sorted((r1, r2) -> this.getResourceName(r1).compareTo(this.getResourceName(r2))).toList();
+        return resources.stream().sorted((r1, r2) -> getResourceName(r1).compareTo(getResourceName(r2))).toList();
     }
 
     /**
@@ -1159,16 +1161,25 @@ public List<Package> getNamespaceImportSelectionDialogChildren(Object self) {
         return result;
     }
 
-    private boolean containsPackage(Resource resource) {
+    private static boolean containsDirectlyOrIndirectlyInstancesOf(Resource resource, EClassifier eClassifier) {
         boolean found = false;
-        TreeIterator<EObject> allContents = resource.getAllContents();
+        final Iterator<EObject> allContents = resource.getAllContents();
         while (!found && allContents.hasNext()) {
-            found = allContents.next() instanceof Package;
+            found = eClassifier.isInstance(allContents.next());
         }
         return found;
     }
 
-    private String getResourceName(Resource resource) {
+    private static boolean containsDirectlyOrIndirectlyInstancesOf(EObject eObject, EClassifier eClassifier) {
+        boolean found = false;
+        final Iterator<EObject> allContents = eObject.eAllContents();
+        while (!found && allContents.hasNext()) {
+            found = eClassifier.isInstance(allContents.next());
+        }
+        return found;
+    }
+
+    private static String getResourceName(Resource resource) {
         return resource.eAdapters().stream()
                 .filter(ResourceMetadataAdapter.class::isInstance)
                 .map(ResourceMetadataAdapter.class::cast)
@@ -1192,4 +1203,63 @@ private List<Package> findClosestPackageInChildren(Element element) {
         }
         return result;
     }
+
+    /**
+     * Provides the root elements in the tree of the selection dialog for the StakeholderParameter creation tool.
+     *
+     * @param editingContext
+     *            the (non-{@code null}) {@link IEditingContext}.
+     * @return the (non-{@code null}) {@link List} of all {@link Resource} that contain at least one {@link PartUsage}.
+     */
+    public List<Resource> getStakeholderSelectionDialogElements(IEditingContext editingContext) {
+        return getAllResourcesWithInstancesOf(editingContext, SysmlPackage.eINSTANCE.getPartUsage());
+    }
+
+    /**
+     * Provides the children of element in the tree of the selection dialog for the StakeholderParameter creation tool.
+     *
+     * @param selectionDialogTreeElement
+     *            a (non-{@code null}) selection dialog tree element.
+     * @return the (non-{@code null}) {@link List} of all children that contain (possibly indirectly) or are
+     *         {@link PartUsage}.
+     */
+    public List<? extends Object> getStakeholderSelectionDialogChildren(Object selectionDialogTreeElement) {
+        return getChildrenWithInstancesOf(selectionDialogTreeElement, SysmlPackage.eINSTANCE.getPartUsage());
+    }
+
+    private static List<Resource> getAllResourcesWithInstancesOf(IEditingContext editingContext, EClassifier eClassifier) {
+        Objects.requireNonNull(editingContext);
+
+        var maybeResourceSet = Optional.of(editingContext)
+                .filter(IEMFEditingContext.class::isInstance)
+                .map(IEMFEditingContext.class::cast)
+                .map(IEMFEditingContext::getDomain)
+                .map(EditingDomain::getResourceSet);
+        var resourcesContainingPartUsage = maybeResourceSet.map(resourceSet -> resourceSet.getResources().stream()
+                .filter(resource -> containsDirectlyOrIndirectlyInstancesOf(resource, eClassifier))
+                .toList())
+                .orElseGet(ArrayList::new);
+        return resourcesContainingPartUsage.stream().sorted(Comparator.comparing(ViewToolService::getResourceName)).toList();
+    }
+
+    private static List<? extends Object> getChildrenWithInstancesOf(Object selectionDialogTreeElement, EClassifier eClassifier) {
+        Objects.requireNonNull(selectionDialogTreeElement);
+
+        final List<? extends Object> result;
+
+        if (selectionDialogTreeElement instanceof Resource resource) {
+            result = resource.getContents().stream()
+                    .filter(content -> eClassifier.isInstance(content) || containsDirectlyOrIndirectlyInstancesOf(content, eClassifier)).toList();
+        } else if (selectionDialogTreeElement instanceof Element sysmlElement) {
+            return sysmlElement.getOwnedRelationship().stream()
+                    .filter(Membership.class::isInstance)
+                    .map(Membership.class::cast)
+                    .map(Membership::getOwnedRelatedElement).flatMap(List::stream)
+                    .filter(content -> eClassifier.isInstance(content) || containsDirectlyOrIndirectlyInstancesOf(content, eClassifier)).toList();
+        } else {
+            result = new ArrayList<>();
+        }
+
+        return result;
+    }
 }

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

@@ -33,11 +33,13 @@ protected String getServiceCallExpression() {
     @Override
     protected SelectionDialogDescription getSelectionDialogDescription() {
         var selectionDialogTree = this.diagramBuilderHelper.newSelectionDialogTreeDescription()
-                .elementsExpression(AQLUtils.getSelfServiceCallExpression("getAllReachableItems"))
+                .elementsExpression(AQLUtils.getServiceCallExpression("editingContext", "getStakeholderSelectionDialogElements"))
+                .childrenExpression(AQLUtils.getSelfServiceCallExpression("getStakeholderSelectionDialogChildren"))
+                .isSelectableExpression("aql:self.oclIsKindOf(sysml::PartUsage)")
                 .build();
         return this.diagramBuilderHelper.newSelectionDialogDescription()
                 .selectionDialogTreeDescription(selectionDialogTree)
-                .selectionMessage("Select an existing Item as stakeholder:")
+                .selectionMessage("Select an existing Part as stakeholder:")
                 .build();
     }
 

doc/content/modules/user-manual/assets/images/release-notes-gv-stakeholder-creation-selection-dialog-tree.png

@@ -89,6 +89,10 @@ image::release-notes-gv-concern-usage.png[Concern Usage node creation tool, widt
 
 image::release-notes-gv-stakeholders.png['stakeholders' compartment, width=50%, height=50%]
 
+- In the `General View` diagram, the stakeholder creation tool displays available `Part Usage` in a tree instead of a list.
+
+image::release-notes-gv-stakeholder-creation-selection-dialog-tree.png['stakeholder creation tool selection dialog tree' compartment, width=50%, height=50%]
+
 - Prevent the edition of imported user libraries from the details view.
 - Align metamodel to SysMLv2 and KerML Beta 2.3 specifications.
 The changes are: