Merge pull request #647 from Systems-Modeling/ST6RI-842

ST6RI-842: Support shorthand notations (PlantUML)

Author: seidewitz

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/SysML2PlantUMLStyle.java

@@ -37,6 +37,7 @@
 import org.omg.sysml.lang.sysml.AllocationUsage;
 import org.omg.sysml.lang.sysml.AnalysisCaseDefinition;
 import org.omg.sysml.lang.sysml.AnalysisCaseUsage;
+import org.omg.sysml.lang.sysml.AssertConstraintUsage;
 import org.omg.sysml.lang.sysml.Behavior;
 import org.omg.sysml.lang.sysml.BindingConnector;
 import org.omg.sysml.lang.sysml.Class;
@@ -52,11 +53,11 @@
 import org.omg.sysml.lang.sysml.FeatureMembership;
 import org.omg.sysml.lang.sysml.FeatureTyping;
 import org.omg.sysml.lang.sysml.FeatureValue;
+import org.omg.sysml.lang.sysml.Flow;
 import org.omg.sysml.lang.sysml.FlowUsage;
 import org.omg.sysml.lang.sysml.Import;
 import org.omg.sysml.lang.sysml.IncludeUseCaseUsage;
 import org.omg.sysml.lang.sysml.ItemDefinition;
-import org.omg.sysml.lang.sysml.Flow;
 import org.omg.sysml.lang.sysml.ItemUsage;
 import org.omg.sysml.lang.sysml.Membership;
 import org.omg.sysml.lang.sysml.MetadataFeature;
@@ -462,16 +463,6 @@ public String caseDependency(Dependency dep) {
             return " ..>> ";
 		}
 
-		@Override
-		public String caseRequirementConstraintMembership(RequirementConstraintMembership requirementConstraintMembership) {
-            return " ..> ";
-		}
-
-		@Override
-		public String caseSatisfyRequirementUsage(SatisfyRequirementUsage satisfyRequirementUsage) {
-            return " ..> ";
-		}
-
 		@Override
 		public String caseBindingConnector(BindingConnector object) {
             return " -[thickness=5]- ";
@@ -506,41 +497,49 @@ public String caseObjectiveMembership(ObjectiveMembership vm) {
 		public String caseImport(Import imp) {
             return " ..> ";
 		}
-    }
 
-    public static class StyleStereotypeDefaultSwitch extends StyleStereotypeSwitch {
 		@Override
-		public String caseClass(Class object) {
-            if (SysMLPackage.Literals.CLASS.equals(object.eClass())) return " ";
-            return null;
+		public String caseRequirementConstraintMembership(RequirementConstraintMembership requirementConstraintMembership) {
+            return " --> ";
 		}
 
 		@Override
-		public String caseExhibitStateUsage(ExhibitStateUsage esu) {
-            if (VStructure.hasRefSubsettingWithoutDeclaredName(esu)) {
-                return " exhibit>> ";
-            } else {
-                return " exhibit state>> ";
-            }
+		public String caseSatisfyRequirementUsage(SatisfyRequirementUsage satisfyRequirementUsage) {
+            return " --> ";
 		}
 
 		@Override
-		public String caseSatisfyRequirementUsage(SatisfyRequirementUsage sru) {
-            return "<<requirement>> ";
+		public String caseAssertConstraintUsage(AssertConstraintUsage acu) {
+            return " --> ";
 		}
 
         @Override
-        public String caseIncludeUseCaseUsage(IncludeUseCaseUsage iucu) {
-            return " include use case>> ";
+		public String casePerformActionUsage(PerformActionUsage pau) {
+            return " --> ";
 		}
 
+        @Override
+		public String caseExhibitStateUsage(ExhibitStateUsage esu) {
+            return " --> ";
+		}
+
+        @Override
+		public String caseEventOccurrenceUsage(EventOccurrenceUsage eou) {
+            return " --> ";
+		}
+
+        @Override
+		public String caseIncludeUseCaseUsage(IncludeUseCaseUsage iuc) {
+            return " --> ";
+		}
+
+    }
+
+    public static class StyleStereotypeDefaultSwitch extends StyleStereotypeSwitch {
 		@Override
-		public String casePerformActionUsage(PerformActionUsage pau) {
-            if (VStructure.hasRefSubsettingWithoutDeclaredName(pau)) {
-                return " perform>> ";
-            } else {
-                return " perform action>> ";
-            }
+		public String caseClass(Class object) {
+            if (SysMLPackage.Literals.CLASS.equals(object.eClass())) return " ";
+            return null;
 		}
 
 		@Override
@@ -573,9 +572,58 @@ public String caseVerificationCaseDefinition(VerificationCaseDefinition acd) {
             return " verification def>> ";
 		}
 
+		@Override
+		public String caseExhibitStateUsage(ExhibitStateUsage esu) {
+            if (Visitor.getSpecialReference(esu) != null) {
+                return " exhibit>> ";
+            } else {
+                return " exhibit state>> ";
+            }
+		}
+
+		@Override
+		public String caseSatisfyRequirementUsage(SatisfyRequirementUsage sru) {
+            if (Visitor.getSpecialReference(sru) != null) {
+                return " satisfy>> ";
+            } else {
+                return " satisfy requirement>> ";
+            }
+		}
+
+        @Override
+        public String caseIncludeUseCaseUsage(IncludeUseCaseUsage iucu) {
+            if (Visitor.getSpecialReference(iucu) != null) {
+                return " include>> ";
+            } else {
+                return " include use case>> ";
+            }
+		}
+
+		@Override
+		public String casePerformActionUsage(PerformActionUsage pau) {
+            if (Visitor.getSpecialReference(pau) != null) {
+                return " perform>> ";
+            } else {
+                return " perform action>> ";
+            }
+		}
+
+		@Override
+		public String caseAssertConstraintUsage(AssertConstraintUsage acu) {
+            if (Visitor.getSpecialReference(acu) != null) {
+                return " assert>> ";
+            } else {
+                return " assert constraint>> ";
+            }
+        }
+
 		@Override
 		public String caseEventOccurrenceUsage(EventOccurrenceUsage eou) {
-            return " event occurrence>> ";
+            if (Visitor.getSpecialReference(eou) != null) {
+                return " event>> ";
+            } else {
+                return " event occurrence>> ";
+            }
 		}
     }
 

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/SysML2PlantUMLText.java

@@ -27,8 +27,10 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -472,6 +474,17 @@ private void addStyleHeader(StringBuilder sb) {
         sb.append('\n');
     }
 
+    private List<Element> topElements;
+
+    /* package */ boolean toBeRendered(EObject eObj) {
+        while (eObj != null) {
+            if (!(eObj instanceof Element)) return false;
+            if (topElements.contains((Element) eObj)) return true;
+            eObj = eObj.eContainer();
+        }
+        return false;
+    }
+
     public String sysML2PUML(List<? extends EObject> eObjs) {
         initStyle();
         this.vpath = new VPath();
@@ -485,9 +498,11 @@ public String sysML2PUML(List<? extends EObject> eObjs) {
         init();
 
         numVisits = 0;
+        this.topElements = new ArrayList<>(eObjs.size());
         for (EObject eObj : eObjs) {
             if (eObj instanceof Element) {
                 Element e = (Element) eObj;
+                topElements.add(e);
                 vpath.visit(e);
             }
         }
@@ -595,14 +610,31 @@ void popIdMap(boolean keep) {
         idMap = idMap.pop(keep);
     }
 
+    private Set<Element> assigned = new HashSet<Element>();
+
     Integer newId(Element e) {
-        return idMap.newId(e);
+        if (assigned.contains(e)) {
+            assigned.remove(e);
+            return idMap.getId(e);
+        } else {
+            return idMap.newId(e);
+        }
     }
 
     Integer getId(Element e) {
         return idMap.getId(e);
     }
 
+    private Integer assignId(Element e) {
+        assigned.add(e);
+        return idMap.getId(e);
+    }
+
+    boolean isReferred(Element e) {
+        int pid = assignId(e);
+        return null != vpath.getPaths(pid);
+    }
+
     private boolean inherited;
     void setInherited(boolean flag) {
         this.inherited = flag;

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VCompartment.java

@@ -59,6 +59,7 @@
 import org.omg.sysml.lang.sysml.ReferenceUsage;
 import org.omg.sysml.lang.sysml.RequirementUsage;
 import org.omg.sysml.lang.sysml.ReturnParameterMembership;
+import org.omg.sysml.lang.sysml.SatisfyRequirementUsage;
 import org.omg.sysml.lang.sysml.StakeholderMembership;
 import org.omg.sysml.lang.sysml.StateDefinition;
 import org.omg.sysml.lang.sysml.StateUsage;
@@ -67,7 +68,6 @@
 import org.omg.sysml.lang.sysml.SuccessionFlow;
 import org.omg.sysml.lang.sysml.TransitionUsage;
 import org.omg.sysml.lang.sysml.Type;
-import org.omg.sysml.lang.sysml.Usage;
 import org.omg.sysml.lang.sysml.VariantMembership;
 import org.omg.sysml.util.ConnectorUtil;
 import org.omg.sysml.util.TypeUtil;
@@ -255,6 +255,11 @@ public String caseReferenceUsage(ReferenceUsage ru) {
     	return null;
     }
 
+    @Override
+    public String caseSatisfyRequirementUsage(SatisfyRequirementUsage sru) {
+        return recCurrent(sru, true);
+    }
+
     @Override
     public String caseRequirementUsage(RequirementUsage ru) {
         return recCurrent(ru, true);
@@ -312,7 +317,7 @@ public String caseVariantMembership(VariantMembership vm) {
 
     @Override
     public String caseObjectiveMembership(ObjectiveMembership om) {
-        //rec(om, om, true);
+        if (isEmptyObjective(om)) return "";
         recOrAddOwningMembership(om);
         return "";
     }
@@ -329,12 +334,6 @@ public String caseStakeholderMembership(StakeholderMembership sm) {
         return "";
     }
 
-    private boolean isEmptySubject(SubjectMembership sm) {
-        Usage u = sm.getOwnedSubjectParameter();
-        if (!"subj".equals(u.getName())) return false;
-        return u.getOwnedRelationship().isEmpty();
-    }
-
     @Override
     public String caseSubjectMembership(SubjectMembership sm) {
         if (isEmptySubject(sm)) return "";