Merge pull request #28 from ModelDriven/ST5AS-55

ST5AS-55 : Filter outgoing/incoming relationships

Author: ivan-gomes

app/controllers/RelationshipController.java

@@ -6,6 +6,7 @@
 import jackson.JsonLdMofObjectAdornment;
 import org.omg.sysml.metamodel.MofObject;
 import org.omg.sysml.metamodel.Relationship;
+import org.omg.sysml.utils.RelationshipDirection;
 import play.Environment;
 import play.libs.Json;
 import play.mvc.Controller;
@@ -15,10 +16,7 @@
 import services.RelationshipService;
 
 import javax.inject.Inject;
-import java.util.List;
-import java.util.Optional;
-import java.util.Set;
-import java.util.UUID;
+import java.util.*;
 import java.util.stream.Collectors;
 
 /**
@@ -57,8 +55,14 @@ public Result create(Http.Request request) {
         return responseRelationship.map(e -> created(Json.toJson(e))).orElseGet(Results::internalServerError);
     }
 
-    public Result getRelationshipsByProjectIdCommitIdRelatedElementId(UUID projectId, UUID commitId, UUID elementId, Http.Request request) {
-        Set<Relationship> relationships = relationshipService.getRelationshipsByProjectCommitRelatedElement(projectId, commitId, elementId);
+    public Result getRelationshipsByProjectIdCommitIdRelatedElementId(UUID projectId, UUID commitId, UUID elementId, Optional<String> direction, Http.Request request) {
+        RelationshipDirection relDirection = direction
+                .flatMap(d -> Arrays.stream(RelationshipDirection.values())
+                        .filter(rd -> rd.toString().equalsIgnoreCase(d))
+                        .findAny())
+                .orElse(RelationshipDirection.BOTH);
+
+        Set<Relationship> relationships = relationshipService.getRelationshipsByProjectCommitRelatedElement(projectId, commitId, elementId, relDirection);
         boolean respondWithJsonLd = ElementController.respondWithJsonLd(request);
         return ok(JacksonHelper.collectionValueToTree(Set.class,
                 respondWithJsonLd ? JsonLdMofObjectAdornment.class : metamodelProvider.getImplementationClass(Relationship.class),

app/org/omg/sysml/utils/RelationshipDirection.java

@@ -0,0 +1,7 @@
+package org.omg.sysml.utils;
+
+public enum RelationshipDirection {
+    IN,
+    OUT,
+    BOTH
+}

app/services/RelationshipService.java

@@ -8,10 +8,12 @@
 import org.omg.sysml.lifecycle.Commit;
 import org.omg.sysml.metamodel.Element;
 import org.omg.sysml.metamodel.Relationship;
+import org.omg.sysml.utils.RelationshipDirection;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import java.util.*;
+import java.util.stream.Collectors;
 
 @Singleton
 public class RelationshipService {
@@ -39,9 +41,25 @@ public Optional<Relationship> create(Relationship relationship) {
         return relationship.getIdentifier() != null ? relationshipDao.update(relationship) : relationshipDao.persist(relationship);
     }
 
-    public Set<Relationship> getRelationshipsByProjectCommitRelatedElement(UUID projectId, UUID commitId, UUID relatedElementId) {
+    public Set<Relationship> getRelationshipsByProjectCommitRelatedElement(UUID projectId, UUID commitId, UUID relatedElementId, RelationshipDirection direction) {
         Commit commit = projectDao.findById(projectId).flatMap(project -> commitDao.findByProjectAndId(project, commitId)).orElseThrow(() -> new IllegalArgumentException("Commit " + commitId + " not found."));
         Element relatedElement = elementDao.findByCommitAndId(commit, relatedElementId).orElseThrow(() -> new IllegalArgumentException("Element " + relatedElementId + " not found."));
-        return relationshipDao.findAllByCommitRelatedElement(commit, relatedElement);
+        Set<Relationship> allRelationships = relationshipDao.findAllByCommitRelatedElement(commit, relatedElement);
+        Set<Relationship> results = allRelationships;
+        if (RelationshipDirection.OUT.equals(direction)) {
+            results = allRelationships.stream()
+                    .filter(r -> r.getSource().stream()
+                            .anyMatch(e -> Objects.equals(e.getIdentifier(), relatedElementId))
+                    )
+                    .collect(Collectors.toSet());
+        } else if (RelationshipDirection.IN.equals(direction)) {
+            results = allRelationships.stream()
+                    .filter(r -> r.getTarget().stream()
+                            .anyMatch(e -> Objects.equals(e.getIdentifier(), relatedElementId))
+                    )
+                    .collect(Collectors.toSet());
+        }
+
+        return results;
     }
 }

conf/routes

@@ -2,6 +2,7 @@
 # This file defines all application routes (Higher priority routes first)
 # ~~~~
 
+
 # An example controller showing a sample home page
 GET         /                                                                                      controllers.HomeController.index
 
@@ -22,7 +23,7 @@ GET         /projects/:projectId/commits/:commitId/elements/:elementId
 GET         /projects/:projectId/commits/:commitId/roots                                           controllers.ElementController.getRootsByProjectIdCommitId(projectId : java.util.UUID, commitId : java.util.UUID, request : Request)
 
 # Relationship endpoints
-GET         /projects/:projectId/commits/:commitId/elements/:relatedElementId/relationships        controllers.RelationshipController.getRelationshipsByProjectIdCommitIdRelatedElementId(projectId : java.util.UUID, commitId : java.util.UUID, relatedElementId : java.util.UUID, request : Request)
+GET         /projects/:projectId/commits/:commitId/elements/:relatedElementId/relationships        controllers.RelationshipController.getRelationshipsByProjectIdCommitIdRelatedElementId(projectId : java.util.UUID, commitId : java.util.UUID, relatedElementId : java.util.UUID, direction : java.util.Optional[String], request : Request)
 
 # Map static resources from the /public folder to the /assets URL path
 GET         /assets/*file                                                                          controllers.Assets.versioned(path="/public", file: Asset)

public/swagger/openapi.yaml

@@ -337,6 +337,16 @@ paths:
         type: string
         format: uuid
         required: true
+      - name: direction
+        in: query
+        description: Filter for relationships that are incoming (in), outgoing (out), or both relative to the related element
+        type: string
+        enum:
+          - 'in'
+          - 'out'
+          - 'both'
+        default: 'both'
+        required: false
     get:
       tags:
         - Relationship