Added support for filtering outgoing/incoming relationships for an element in a given project and commit

Author: manasbajaj

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;
@@ -57,8 +58,18 @@ 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 = RelationshipDirection.BOTH;
+        if(direction.isPresent()) {
+            if(direction.get().equalsIgnoreCase(RelationshipDirection.IN.toString()))
+                relDirection = RelationshipDirection.IN;
+            else if(direction.get().equalsIgnoreCase(RelationshipDirection.OUT.toString()))
+                relDirection = RelationshipDirection.OUT;
+            else
+                relDirection = RelationshipDirection.BOTH;
+        }
+
+        Set<Relationship> relationships = relationshipService.getRelationshipsByProjectCommitRelatedElement(projectId, commitId, elementId, Optional.of(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,19 @@ 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, Optional<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 (direction.isPresent()) {
+            if (direction.get().equals(RelationshipDirection.OUT)) {
+                results = allRelationships.stream().filter(r -> r.getSource().stream().anyMatch(e -> e.getIdentifier().equals(relatedElementId))).collect(Collectors.toSet());
+            } else if (direction.get().equals(RelationshipDirection.IN)) {
+                results = allRelationships.stream().filter(r -> r.getTarget().stream().anyMatch(e -> e.getIdentifier().equals(relatedElementId))).collect(Collectors.toSet());
+            }
+        }
+
+        return results;
     }
 }

build.sbt

@@ -33,3 +33,5 @@ javacOptions in Compile ++= Seq("-s", "generated")
 
 sources in(Compile, doc) := Seq.empty
 publishArtifact in(Compile, packageDoc) := false
+
+//routesImport += “org.omg.sysml.utils.RelationshipDirection”

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)