feature: Show references on delete and allow selective deleting (RDFA-136)

backend/src/main/java/org/rdfarchitect/api/controller/datasets/graphs/DeleteRESTController.java

@@ -0,0 +1,147 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.controller.datasets.graphs;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import lombok.RequiredArgsConstructor;
+
+import org.rdfarchitect.api.dto.delete.ResourceDeleteRequest;
+import org.rdfarchitect.api.dto.delete.relations.AffectedResource;
+import org.rdfarchitect.database.GraphIdentifier;
+import org.rdfarchitect.services.ExpandURIUseCase;
+import org.rdfarchitect.services.delete.DeleteResourcesUseCase;
+import org.rdfarchitect.services.delete.FindDeleteDependenciesUseCase;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpHeaders;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+import java.util.UUID;
+
+@RestController
+@RequestMapping("api/datasets/{datasetName}/graphs/{graphURI}")
+@RequiredArgsConstructor
+public class DeleteRESTController {
+
+    private static final Logger logger = LoggerFactory.getLogger(DeleteRESTController.class);
+
+    private final ExpandURIUseCase expandURIUseCase;
+    private final FindDeleteDependenciesUseCase findDeleteDependenciesUseCase;
+    private final DeleteResourcesUseCase deleteResourcesUseCase;
+
+    @Operation(
+            summary = "Get deletion impact",
+            description =
+                    "Returns a tree of affected resources for deleting the resource with the given UUID.",
+            tags = {"graph"},
+            responses = {@ApiResponse(responseCode = "200")})
+    @GetMapping("/uuid/{uuid}/deletion-impact")
+    public AffectedResource getDeletionImpact(
+            @Parameter(description = "The name/url of the inquirer.")
+                    @RequestHeader(
+                            value = HttpHeaders.ORIGIN,
+                            required = false,
+                            defaultValue = "unknown")
+                    String originURL,
+            @Parameter(description = "The literal name of the dataset.") @PathVariable
+                    String datasetName,
+            @Parameter(
+                            description =
+                                    "The url encoded uri of the graph, or \"default\" to access the default graph.")
+                    @PathVariable
+                    String graphURI,
+            @Parameter(description = "The url encoded iri identifier of the cim resource.")
+                    @PathVariable
+                    String uuid) {
+        logger.info(
+                "Received GET request: \"/api/datasets/{{}}/graphs/{{}}/uuid/{{}/deletion-impact\" from \"{}\".",
+                datasetName,
+                graphURI,
+                uuid,
+                originURL);
+
+        var extendedGraphURI = expandURIUseCase.expandUri(datasetName, graphURI);
+
+        var resultObj =
+                findDeleteDependenciesUseCase.getDeleteDependencies(
+                        new GraphIdentifier(datasetName, extendedGraphURI), UUID.fromString(uuid));
+
+        logger.info(
+                "Sending response to GET request: \"/api/datasets/{{}}/graphs/{{}}/uuid/{{}/deletion-impact\" from \"{}\".",
+                datasetName,
+                graphURI,
+                uuid,
+                originURL);
+        return resultObj;
+    }
+
+    @Operation(
+            summary = "Delete resources",
+            description =
+                    "Processes a list of delete requests, each specifying a resource UUID and the desired action.",
+            tags = {"graph"},
+            responses = {@ApiResponse(responseCode = "200")})
+    @PostMapping("/delete-requests")
+    public String deleteResources(
+            @Parameter(description = "The name/url of the inquirer.")
+                    @RequestHeader(
+                            value = HttpHeaders.ORIGIN,
+                            required = false,
+                            defaultValue = "unknown")
+                    String originURL,
+            @Parameter(description = "The literal name of the dataset.") @PathVariable
+                    String datasetName,
+            @Parameter(
+                            description =
+                                    "The url encoded uri of the graph, or \"default\" to access the default graph.")
+                    @PathVariable
+                    String graphURI,
+            @Parameter(
+                            description =
+                                    "A list of resource delete requests, each containing the uuid of the resource to delete and the type of deletion")
+                    @RequestBody
+                    List<ResourceDeleteRequest> deleteRequests) {
+        logger.info(
+                "Received POST request: \"/api/datasets/{{}}/graphs/{{}}/delete\" from \"{}\".",
+                datasetName,
+                graphURI,
+                originURL);
+
+        var extendedGraphURI = expandURIUseCase.expandUri(datasetName, graphURI);
+
+        deleteResourcesUseCase.executeDeleteRequests(
+                new GraphIdentifier(datasetName, extendedGraphURI), deleteRequests);
+
+        logger.info(
+                "Sending response to POST request: \"/api/datasets/{{}}/graphs/{{}}/delete\" from \"{}\".",
+                datasetName,
+                graphURI,
+                originURL);
+        return "success";
+    }
+}

backend/src/main/java/org/rdfarchitect/api/controller/datasets/graphs/classes/AllClassesRESTController.java

@@ -41,6 +41,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
@@ -155,7 +156,10 @@ public List<ClassUMLAdaptedDTO> getClassList(
                             description =
                                     "The url encoded uri of the graph, or \"default\" to access the default graph.")
                     @PathVariable
-                    String graphURI) {
+                    String graphURI,
+            @Parameter(description = "Whether to include external classes.")
+                    @RequestParam(required = false, defaultValue = "false")
+                    boolean includeExternalClasses) {
         logger.info(
                 "Received GET request: \"/api/datasets/{{}}/graphs/{{}}/classes\" from \"{}\".",
                 datasetName,
@@ -166,7 +170,7 @@ public List<ClassUMLAdaptedDTO> getClassList(
 
         var cimClassList =
                 getClassListUseCase.getClassList(
-                        new GraphIdentifier(datasetName, extendedGraphURI));
+                        new GraphIdentifier(datasetName, extendedGraphURI), includeExternalClasses);
 
         logger.info(
                 "Sending response to GET request: \"/api/datasets/{{}}/graphs/{{}}/classes\" to \"{}\".",

backend/src/main/java/org/rdfarchitect/api/dto/delete/DeleteAction.java

@@ -0,0 +1,41 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.dto.delete;
+
+public enum DeleteAction {
+
+    /** Delete the affected resource entirely. Applicable to all resource types. */
+    DELETE,
+
+    /**
+     * Keep the affected resource as-is, even though it references a deleted resource. E.g. a class
+     * that extends a deleted class — keep the class but accept that the parent reference becomes
+     * invalid.
+     */
+    KEEP,
+
+    /**
+     * Remove the {@code cims:belongsToCategory} triple from a class whose package is being deleted.
+     */
+    REMOVE_PACKAGE_REFERENCE,
+
+    /**
+     * Remove the {@code rdfs:subClassOf} triple from a class whose parent class is being deleted.
+     */
+    REMOVE_SUBCLASS_REFERENCE;
+}

backend/src/main/java/org/rdfarchitect/api/dto/delete/ResourceDeleteRequest.java

@@ -0,0 +1,30 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.dto.delete;
+
+import lombok.Data;
+
+import java.util.UUID;
+
+@Data
+public class ResourceDeleteRequest {
+
+    private UUID uuid;
+
+    private DeleteAction action;
+}

backend/src/main/java/org/rdfarchitect/api/dto/delete/ResourceIdentifier.java

@@ -0,0 +1,31 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.dto.delete;
+
+import lombok.Data;
+import lombok.experimental.Accessors;
+
+import java.util.UUID;
+
+@Data
+@Accessors(chain = true)
+public class ResourceIdentifier {
+    private UUID uuid;
+    private String label;
+    private String namespace;
+}

backend/src/main/java/org/rdfarchitect/api/dto/delete/relations/AffectedAssociation.java

@@ -0,0 +1,45 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.dto.delete.relations;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+
+import org.rdfarchitect.api.dto.delete.ResourceIdentifier;
+import org.rdfarchitect.models.cim.relations.model.CIMResourceTypeIdentifyingUtils;
+
+@Data
+@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+public class AffectedAssociation extends AffectedOwnedResource {
+
+    private ResourceIdentifier target;
+
+    public AffectedAssociation(
+            ResourceIdentifier resourceIdentifier,
+            CIMResourceTypeIdentifyingUtils.CimResourceType type,
+            AffectedResourceReason reason,
+            ResourceIdentifier domain,
+            ResourceIdentifier target) {
+        super(resourceIdentifier, type, reason, domain);
+        this.target = target;
+    }
+}

backend/src/main/java/org/rdfarchitect/api/dto/delete/relations/AffectedOwnedResource.java

@@ -0,0 +1,44 @@
+/*
+ *    Copyright (c) 2024-2026 SOPTIM AG
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ */
+
+package org.rdfarchitect.api.dto.delete.relations;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+
+import org.rdfarchitect.api.dto.delete.ResourceIdentifier;
+import org.rdfarchitect.models.cim.relations.model.CIMResourceTypeIdentifyingUtils;
+
+@Data
+@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+public class AffectedOwnedResource extends AffectedResource {
+
+    private ResourceIdentifier domain;
+
+    public AffectedOwnedResource(
+            ResourceIdentifier resourceIdentifier,
+            CIMResourceTypeIdentifyingUtils.CimResourceType type,
+            AffectedResourceReason reason,
+            ResourceIdentifier domain) {
+        super(resourceIdentifier, type, reason);
+        this.domain = domain;
+    }
+}