Merge pull request #326 from bci-oss/bug/310-diagram-name-collision

Fix for names collision during diagram generation

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/diagram/AspectModelDiagramGenerator.java

@@ -78,6 +78,7 @@ public String getArtifactFilename( final String aspectName, final Locale languag
    private static final String FONT_FILE = "diagram/RobotoCondensed-Regular.ttf";
 
    static final String GET_ELEMENT_NAME_FUNC = "urn:samm:org.eclipse.esmf.samm:function:2.0.0#getElementName";
+   static final String GET_NAMESPACE_FUNC = "urn:samm:org.eclipse.esmf.samm:function:2.0.0#getNamespace";
 
    private final Query boxmodelToDotQuery;
    private final BoxModel boxModelNamespace;
@@ -143,7 +144,10 @@ ImmutableList.<String> builder().addAll( queryFilesForAllMetaModelVersions )
       boxmodelToDotQuery = QueryFactory.create( getInputStreamAsString( "boxmodel2dot.sparql" ) );
       boxModelNamespace = new BoxModel( metaModelVersion );
 
-      sparqlExecutor = new SparqlExecutor().useCustomFunction( GET_ELEMENT_NAME_FUNC, new GetElementNameFunctionFactory( model ) );
+      sparqlExecutor = new SparqlExecutor()
+            .useCustomFunction( GET_ELEMENT_NAME_FUNC, new GetElementNameFunctionFactory( model ) )
+            .useCustomFunction( GET_NAMESPACE_FUNC, new GetNamespaceFunctionFactory( model ) )
+      ;
    }
 
    InputStream getInputStream( final String resource ) {

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/diagram/GetNamespaceFunctionFactory.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.diagram;
+
+import org.apache.jena.graph.Node;
+import org.apache.jena.rdf.model.Model;
+import org.apache.jena.sparql.expr.NodeValue;
+import org.apache.jena.sparql.function.Function;
+import org.apache.jena.sparql.function.FunctionBase1;
+import org.apache.jena.sparql.function.FunctionFactory;
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
+
+/**
+ * {@link FunctionFactory} for the {@link getNamespace} SPARQL function.
+ */
+public class GetNamespaceFunctionFactory implements FunctionFactory {
+
+   private final getNamespace getNamespace;
+
+   /**
+    */
+   public GetNamespaceFunctionFactory( final Model context ) {
+      this.getNamespace = new getNamespace( context.getNsPrefixURI( "" ) );
+   }
+
+   @Override
+   public Function create( String s ) {
+      return getNamespace;
+   }
+
+   /**
+    * A custom SPARQL function which provides the namespace of a model element.
+    */
+   private static class getNamespace extends FunctionBase1 {
+
+      private final String defaultNs;
+
+      public getNamespace( String defaultNs ) {
+         this.defaultNs = defaultNs;
+      }
+
+      @Override
+      public NodeValue exec( NodeValue nodeValue ) {
+         final Node node = nodeValue.asNode();
+         if ( node.isBlank() || !node.isURI() ) {
+            return NodeValue.makeNodeString( defaultNs );
+         }
+         final AspectModelUrn nodeUrn = AspectModelUrn.fromUrn( node.getURI() );
+         return NodeValue.makeString( nodeUrn.getUrnPrefix() );
+      }
+   }
+}

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/aspect-operation-edges2boxmodel.sparql

@@ -12,6 +12,7 @@
 prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0#>
 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generate edges between Aspects and Operations
 construct {
@@ -27,9 +28,9 @@ construct {
   filter( exists { ?aspect samm:operations/rdf:rest*/rdf:first ?operation } )
 
   bind( concat( ?aspectName, "Aspect" ) as ?aspectBoxName )
-  bind( iri( concat( str( : ), ?aspectBoxName ) ) as ?from )
+  bind( iri( concat( func:getNamespace( ?aspect ), ?aspectBoxName ) ) as ?from )
   bind( concat( ?operationName, "Operation" ) as ?operationBoxName )
-  bind( iri( concat( str( : ), ?operationBoxName ) ) as ?to )
+  bind( iri( concat( func:getNamespace( ?operation ), ?operationBoxName ) ) as ?to )
 
-  bind( iri( concat( str( : ), ?aspectBoxName, "_To_", ?operationBoxName ) ) as ?edge )
+  bind( iri( concat( func:getNamespace( ?aspect ), ?aspectBoxName, "_To_", ?operationBoxName ) ) as ?edge )
 }

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/aspect-property-edges2boxmodel.sparql

@@ -14,6 +14,7 @@ prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:1.0.0#>
 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates edges between Aspects or Entites and Properties
 construct {
@@ -38,12 +39,12 @@ construct {
 
     bind( if( ?class = samm:Aspect, "Aspect", "Entity" ) as ?typeName )
     bind( concat( ?aspectOrEntityName, ?typeName ) as ?aspectOrEntityBoxName )
-    bind( iri( concat( str( : ), ?aspectOrEntityBoxName ) ) as ?from )
+    bind( iri( concat( func:getNamespace( ?aspectOrEntity ), ?aspectOrEntityBoxName ) ) as ?from )
 
     bind( concat( ?propertyName, "Property" ) as ?propertyBoxName )
-    bind( iri( concat( str( : ), ?propertyBoxName ) ) as ?to )
+    bind( iri( concat( func:getNamespace( ?property ), ?propertyBoxName ) ) as ?to )
 
-    bind( iri( concat( str( : ), ?aspectOrEntityBoxName, "_To_", ?propertyBoxName ) ) as ?edge )
+    bind( iri( concat( func:getNamespace( ?aspectOrEntity ), ?aspectOrEntityBoxName, "_To_", ?propertyBoxName ) ) as ?edge )
 
     optional {
       ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
@@ -75,8 +76,8 @@ construct {
     }
 
     optional {
-       ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
-       bind( "property" as ?title )
+      ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
+      bind( "property" as ?title )
     }
   }
 
@@ -94,12 +95,12 @@ construct {
     ?refiningEntity samm:name ?entityName .
     ?property samm:name ?propertyName .
     bind( concat( ?entityName, "Entity" ) as ?entityBoxName )
-    bind( iri( concat( str( : ), ?entityBoxName ) ) as ?from )
+    bind( iri( concat( func:getNamespace( ?refiningEntity ), ?entityBoxName ) ) as ?from )
 
     bind( concat( ?propertyName, "Property" ) as ?propertyBoxName )
-    bind( iri( concat( str( : ), ?propertyBoxName ) ) as ?to )
+    bind( iri( concat( func:getNamespace( ?property ), ?propertyBoxName ) ) as ?to )
 
-    bind( iri( concat( str( : ), ?entityBoxName, "_To_", ?propertyBoxName ) ) as ?edge )
+    bind( iri( concat( func:getNamespace( ?refiningEntity ), ?entityBoxName, "_To_", ?propertyBoxName ) ) as ?edge )
 
     optional {
       ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
@@ -131,8 +132,8 @@ construct {
     }
 
     optional {
-       ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
-       bind( "property" as ?title )
+      ?aspectOrEntity samm:properties/rdf:rest*/rdf:first ?propertyNode .
+      bind( "property" as ?title )
     }
   }
 }

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/aspect2boxmodel.sparql

@@ -12,6 +12,7 @@
 prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0#>
 prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates boxes for Aspects
 construct {
@@ -40,7 +41,7 @@ construct {
   ?aspect samm:name ?aspectName .
 
   bind( concat( ?aspectName, "Aspect" ) as ?boxName )
-  bind( iri( concat( str( : ), ?boxName ) ) as ?aspectBox )
+  bind( iri( concat( func:getNamespace( ?aspect ), ?boxName ) ) as ?aspectBox )
 
   optional {
     ?aspect samm:preferredName ?preferredNameValue .

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/characteristic-characteristic-edges2boxmodel.sparql

@@ -13,6 +13,7 @@ prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0#>
 prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:1.0.0#>
 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates edges between Trait and other Characteristics (baseCharacteristic)
 construct {
@@ -25,11 +26,11 @@ construct {
   ?characteristic samm-c:baseCharacteristic ?baseCharacteristic .
   ?baseCharacteristic samm:name ?baseCharacteristicName .
   bind( concat( ?characteristicName, "Characteristic" ) as ?box1Name )
-  bind( iri( concat( str( : ), ?box1Name ) ) as ?from )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?box1Name ) ) as ?from )
 
   bind( concat( ?baseCharacteristicName, "Characteristic" ) as ?box2Name )
-  bind( iri( concat( str( : ), ?box2Name ) ) as ?to )
+  bind( iri( concat( func:getNamespace( ?baseCharacteristic ), ?box2Name ) ) as ?to )
 
-  bind( iri( concat( str( : ), ?box1Name, "_To_", ?box2Name ) ) as ?edge )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?box1Name, "_To_", ?box2Name ) ) as ?edge )
 }
 

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/characteristic-constraint-edges2boxmodel.sparql

@@ -16,6 +16,7 @@ prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
 prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates edges between Trait and Constraints (constraint)
 construct {
@@ -28,7 +29,7 @@ construct {
   ?characteristic samm:name ?characteristicName .
 
   bind( concat( ?characteristicName, "Characteristic" ) as ?characteristicBoxName )
-  bind( iri( concat( str( : ), ?characteristicBoxName ) ) as ?from )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName ) ) as ?from )
 
   optional {
     ?constraint samm:name ?givenConstraintName .
@@ -59,8 +60,8 @@ construct {
   bind( coalesce( concat( ?givenConstraintName, "Constraint" ),
                  concat( "Constraint", substr( md5( ?constraintPropertyValues ), 0, 11 ) ) ) as ?constraintBoxName )
 
-  bind( iri( concat( str( : ), ?constraintBoxName ) ) as ?to )
+  bind( iri( concat( func:getNamespace( ?constraint ), ?constraintBoxName ) ) as ?to )
 
-  bind( iri( concat( str( : ), ?characteristicBoxName, "_To_", ?constraintBoxName ) ) as ?edge )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName, "_To_", ?constraintBoxName ) ) as ?edge )
 }
 

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/characteristic-entity-edges2boxmodel.sparql

@@ -14,6 +14,7 @@ prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:1.0.0#>
 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates edges between Characteristic and Entities (dataType)
 construct {
@@ -29,11 +30,11 @@ construct {
   ?characteristic samm:name ?characteristicName .
   ?entity samm:name ?entityName .
   bind( concat( ?characteristicName, "Characteristic" ) as ?characteristicBoxName )
-  bind( iri( concat( str( : ), ?characteristicBoxName ) ) as ?from )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName ) ) as ?from )
 
   bind( concat( ?entityName, "Entity" ) as ?entityBoxName )
-  bind( iri( concat( str( : ), ?entityBoxName ) ) as ?to )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?entityBoxName ) ) as ?to )
 
-  bind( iri( concat( str( : ), ?characteristicBoxName, "_To_", ?entityBoxName ) ) as ?edge )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName, "_To_", ?entityBoxName ) ) as ?edge )
 }
 

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/characteristic-metamodelnode-edges2boxmodel.sparql

@@ -13,6 +13,7 @@ prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0#>
 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates edges between Characteristic and Meta Model Properties (dataType)
 construct {
@@ -27,10 +28,10 @@ construct {
   ?metaModelElement rdfs:label ?metaModelElementName .
 
   bind( concat( ?characteristicName, "Characteristic" ) as ?characteristicBoxName )
-  bind( iri( concat( str( : ), ?characteristicBoxName ) ) as ?from )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName ) ) as ?from )
   bind( concat( ?metaModelElementName, "MetaModelElement" ) as ?metaModelElementBoxName )
-  bind( iri( concat( str( : ), ?metaModelElementBoxName ) ) as ?to )
+  bind( iri( concat( func:getNamespace( ?metaModelElement ), ?metaModelElementBoxName ) ) as ?to )
 
-  bind( iri( concat( str( : ), ?characteristicBoxName, "_To_", ?metaModelElementBoxName ) ) as ?edge )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?characteristicBoxName, "_To_", ?metaModelElementBoxName ) ) as ?edge )
 }
 

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_1_0_0/characteristic2boxmodel.sparql

@@ -15,6 +15,7 @@ prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
 prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
 
 # Generates boxes for Characteristics that are not Collections, Constraints, Enumeration/State or StructuredValue
 construct {
@@ -67,7 +68,7 @@ construct {
 
   ?characteristic samm:name ?characteristicName .
   bind( concat( ?characteristicName, "Characteristic" ) as ?boxName )
-  bind( iri( concat( str( : ), ?boxName ) ) as ?characteristicBox )
+  bind( iri( concat( func:getNamespace( ?characteristic ), ?boxName ) ) as ?characteristicBox )
 
   optional {
     ?characteristic samm:preferredName ?preferredNameValue .