Adapt esmf-aspect-model-document-generators to SAMM 2.1.0

Author: atextor

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

@@ -24,7 +24,6 @@
 import java.io.OutputStream;
 import java.io.UncheckedIOException;
 import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
 import java.util.Base64;
 import java.util.EnumMap;
 import java.util.List;
@@ -33,22 +32,8 @@
 import java.util.Scanner;
 import java.util.Set;
 import java.util.function.Function;
-import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 
-import org.apache.commons.text.StringEscapeUtils;
-import org.apache.commons.text.WordUtils;
-import org.apache.jena.query.ARQ;
-import org.apache.jena.query.Query;
-import org.apache.jena.query.QueryFactory;
-import org.apache.jena.rdf.model.Model;
-import org.apache.jena.rdf.model.ModelFactory;
-import org.apache.jena.rdf.model.Property;
-import org.apache.jena.rdf.model.RDFNode;
-import org.apache.jena.rdf.model.Resource;
-import org.apache.jena.rdf.model.ResourceFactory;
-import org.apache.jena.rdf.model.Statement;
-import org.apache.jena.vocabulary.RDF;
 import org.eclipse.esmf.aspectmodel.UnsupportedVersionException;
 import org.eclipse.esmf.aspectmodel.generator.LanguageCollector;
 import org.eclipse.esmf.aspectmodel.resolver.services.MetaModelUrls;
@@ -59,10 +44,22 @@
 import org.eclipse.esmf.samm.KnownVersion;
 
 import com.google.common.collect.ImmutableList;
-
 import guru.nidi.graphviz.engine.Graphviz;
 import guru.nidi.graphviz.model.MutableGraph;
 import guru.nidi.graphviz.parse.Parser;
+import org.apache.commons.text.StringEscapeUtils;
+import org.apache.commons.text.WordUtils;
+import org.apache.jena.query.ARQ;
+import org.apache.jena.query.Query;
+import org.apache.jena.query.QueryFactory;
+import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.ModelFactory;
+import org.apache.jena.rdf.model.Property;
+import org.apache.jena.rdf.model.RDFNode;
+import org.apache.jena.rdf.model.Resource;
+import org.apache.jena.rdf.model.ResourceFactory;
+import org.apache.jena.rdf.model.Statement;
+import org.apache.jena.vocabulary.RDF;
 
 public class AspectModelDiagramGenerator {
    public enum Format {
@@ -140,6 +137,11 @@ ImmutableList.<String> builder().addAll( queryFilesForAllMetaModelVersions )
                   .addAll( queryFilesForMetaModelVersionsAsOf2_0_0 )
                   .build() );
 
+      aspectToBoxmodelQueryFiles.put( KnownVersion.SAMM_2_1_0,
+            ImmutableList.<String> builder().addAll( queryFilesForAllMetaModelVersions )
+                  .addAll( queryFilesForMetaModelVersionsAsOf2_0_0 )
+                  .build() );
+
       ARQ.init();
       model = versionedModel.getModel();
       metaModelVersion = KnownVersion.fromVersionString( versionedModel.getMetaModelVersion().toString() )
@@ -171,7 +173,7 @@ String getInputStreamAsString( final String resource ) {
    private void generatePng( final String dotInput, final OutputStream output ) throws IOException {
       // To make the font available during PNG generation, it needs to be registered
       // in Java Runtime's graphics environment
-      try{
+      try {
          final File tmpFontFile = generateTmpFontFile();
          final Font f = Font.createFont( Font.TRUETYPE_FONT, tmpFontFile );
          final GraphicsEnvironment ge = GraphicsEnvironment.getLocalGraphicsEnvironment();
@@ -184,17 +186,19 @@ private void generatePng( final String dotInput, final OutputStream output ) thr
       final Graphviz graphviz = Graphviz.fromGraph( g );
       graphviz.render( guru.nidi.graphviz.engine.Format.PNG ).toOutputStream( output );
    }
+
    private File generateTmpFontFile() throws IOException {
-      File tempFontFile = new File( System.getProperty( "java.io.tmpdir" ) + File.separator + "aspect-model-diagram.tmp" );
-      if ( !tempFontFile.exists() ){
+      final File tempFontFile = new File( System.getProperty( "java.io.tmpdir" ) + File.separator + "aspect-model-diagram.tmp" );
+      if ( !tempFontFile.exists() ) {
          try ( final InputStream fontStream = getInputStream( FONT_FILE );
-              final OutputStream output = new FileOutputStream( tempFontFile, false ) ){
-               fontStream.transferTo( output );
-            }
+               final OutputStream output = new FileOutputStream( tempFontFile, false ) ) {
+            fontStream.transferTo( output );
+         }
       }
       tempFontFile.deleteOnExit();
-      return  tempFontFile;
+      return tempFontFile;
    }
+
    private String base64EncodeInputStream( final InputStream in ) throws IOException {
       try ( final ByteArrayOutputStream os = new ByteArrayOutputStream() ) {
          final byte[] buffer = new byte[1024];
@@ -223,16 +227,16 @@ private void generateSvg( final String dotInput, final OutputStream output ) thr
                + "\");\n"
                + "}\n"
                + "</style>";
-         final String result = svgOutput.toString( StandardCharsets.UTF_8.name() )
+         final String result = svgOutput.toString( StandardCharsets.UTF_8 )
                .replaceFirst( ">", ">" + css );
-         output.write( result.getBytes( StandardCharsets.UTF_8.name() ) );
+         output.write( result.getBytes( StandardCharsets.UTF_8 ) );
       }
    }
 
    private void breakLongLinesAndEscapeTexts( final Model model ) {
       final Property text = boxModelNamespace.text();
       final Iterable<Statement> statementIterable = () -> model.listStatements( null, text, (RDFNode) null );
-      StreamSupport.stream( statementIterable.spliterator(), false ).collect( Collectors.toList() )
+      StreamSupport.stream( statementIterable.spliterator(), false ).toList()
             .forEach( oldStatement -> {
                final String newValue = WordUtils.wrap( oldStatement.getLiteral().getString(), 60, "\\l   ", false );
                final String escapedValue = StringEscapeUtils.escapeHtml4( newValue );
@@ -297,15 +301,9 @@ public void generateDiagram( final Format outputFormat, final Locale language, f
       final String dotResult = generateDot( language );
 
       switch ( outputFormat ) {
-      case DOT:
-         out.write( dotResult.getBytes( StandardCharsets.UTF_8 ) );
-         break;
-      case PNG:
-         generatePng( dotResult, out );
-         break;
-      case SVG:
-         generateSvg( dotResult, out );
-         break;
+         case DOT -> out.write( dotResult.getBytes( StandardCharsets.UTF_8 ) );
+         case PNG -> generatePng( dotResult, out );
+         case SVG -> generateSvg( dotResult, out );
       }
    }
 
@@ -349,15 +347,9 @@ public void generateDiagrams( final Set<Format> targetFormats, final Locale lang
          try ( final OutputStream outputStream = nameMapper
                .apply( format.getArtifactFilename( aspectName, language ) ) ) {
             switch ( format ) {
-            case DOT:
-               outputStream.write( dotResult.getBytes( StandardCharsets.UTF_8.name() ) );
-               break;
-            case PNG:
-               generatePng( dotResult, outputStream );
-               break;
-            case SVG:
-               generateSvg( dotResult, outputStream );
-               break;
+               case DOT -> outputStream.write( dotResult.getBytes( StandardCharsets.UTF_8 ) );
+               case PNG -> generatePng( dotResult, outputStream );
+               case SVG -> generateSvg( dotResult, outputStream );
             }
          }
       }

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_2_1_0/abstractentity2boxmodel.sparql

@@ -0,0 +1,74 @@
+# 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
+
+prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.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:2.1.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
+
+# Generates boxes for Abstract Entities
+construct {
+  ?abstractEntityBox a :Box .
+  ?abstractEntityBox :prototype "Abstract Entity" .
+  ?abstractEntityBox :title ?abstractEntityName .
+  ?abstractEntityBox :modelElement ?abstractEntity .
+  ?abstractEntityBox :entries (
+     [
+       a :Entry ;
+       :title "preferredName" ;
+       :text ?preferredName
+     ]
+     [
+       a :Entry ;
+       :title "description" ;
+       :text ?description
+     ]
+     [
+       a :Entry ;
+       :title "see" ;
+       :text ?seeValues
+     ]
+  )
+} where {
+  ?abstractEntity rdf:type samm:AbstractEntity .
+  bind( strafter( str( ?abstractEntity ), "#" ) as ?abstractEntityName )
+
+  bind( concat( ?abstractEntityName, "AbstractEntity" ) as ?boxName )
+  bind( iri( concat( func:getNamespace( ?abstractEntity ), ?boxName ) ) as ?abstractEntityBox )
+
+  optional {
+    ?abstractEntity samm:preferredName ?preferredNameValue .
+    filter( lang( ?preferredNameValue ) = "en" )
+    bind( xsd:string( ?preferredNameValue ) as ?preferredName )
+  }
+
+  optional {
+    ?abstractEntity samm:description ?descriptionValue .
+    filter( lang( ?descriptionValue ) = "en" )
+    bind( xsd:string( ?descriptionValue ) as ?description )
+  }
+
+  optional {
+    {
+      select ( group_concat( ?seeValue; separator=", " ) as ?seeValues ) ?abstractEntity
+      where {
+        select *
+        where {
+          ?abstractEntity rdf:type samm:AbstractEntity .
+          ?abstractEntity samm:see ?seeValue .
+        }
+        order by str( ?seeValue )
+      }
+      group by ?abstractEntity
+    }
+  }
+}

core/esmf-aspect-model-document-generators/src/main/resources/diagram/samm_2_1_0/abstractproperty2boxmodel.sparql

@@ -0,0 +1,83 @@
+# 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
+
+prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#>
+prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.1.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:2.1.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
+
+# Generates boxes for Properties
+construct {
+  ?propertyBox a :Box .
+  ?propertyBox :prototype "AbstractProperty" .
+  ?propertyBox :title ?propertyName .
+  ?propertyBox :modelElement ?property .
+  ?propertyBox :entries (
+     [
+       a :Entry ;
+       :title "preferredName" ;
+       :text ?preferredName
+     ]
+     [
+       a :Entry ;
+       :title "description" ;
+       :text ?description
+     ]
+     [
+       a :Entry ;
+       :title "see" ;
+       :text ?seeValues
+     ]
+  )
+} where {
+  #process Properties defined in the Aspect Model being processed
+  {
+    ?property rdf:type samm:AbstractProperty .
+    bind( strafter( str( ?property ), "#" ) as ?propertyName ) .
+
+    bind( concat( ?propertyName, "AbstractProperty" ) as ?boxName )
+    bind( iri( concat( func:getNamespace( ?property ), ?boxName ) ) as ?propertyBox )
+
+    optional {
+      ?property samm:preferredName ?preferredNameValue .
+      filter( lang( ?preferredNameValue ) = "en" )
+      bind( xsd:string( ?preferredNameValue ) as ?preferredName )
+    }
+
+    optional {
+      ?property samm:description ?descriptionValue .
+      filter( lang( ?descriptionValue ) = "en" )
+      bind( xsd:string( ?descriptionValue ) as ?description )
+    }
+
+    #subquery which concatenates all values for the samm:see attributes
+    optional {
+      select * where {
+        ?property rdf:type samm:Property .
+        filter( str( ?subQueryProperty ) = str( ?property ) )
+        {
+          select ?subQueryProperty ( group_concat( ?seeValue; separator=", " ) as ?seeValues )
+          where {
+            select *
+            where {
+              ?subQueryProperty rdf:type samm:Property .
+              ?subQueryProperty samm:see ?seeValue .
+            }
+            order by str( ?seeValue )
+          }
+          group by ?subQueryProperty
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,36 @@
+# 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
+
+prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#>
+prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
+prefix : <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0/boxmodel#>
+prefix func: <urn:samm:org.eclipse.esmf.samm:function:2.0.0#>
+
+# Generate edges between Aspects and Operations
+construct {
+  ?edge a :Edge .
+  ?edge :title "operation" .
+  ?edge :from ?from .
+  ?edge :to ?to .
+} where {
+  ?aspect a samm:Aspect .
+  bind( strafter( str( ?aspect ), "#" ) as ?aspectName ) .
+  ?operation a samm:Operation .
+  bind( strafter( str( ?operation ), "#" ) as ?operationName ) .
+  filter( exists { ?aspect samm:operations/rdf:rest*/rdf:first ?operation } )
+
+  bind( concat( ?aspectName, "Aspect" ) as ?aspectBoxName )
+  bind( iri( concat( func:getNamespace( ?aspect ), ?aspectBoxName ) ) as ?from )
+  bind( concat( ?operationName, "Operation" ) as ?operationBoxName )
+  bind( iri( concat( func:getNamespace( ?operation ), ?operationBoxName ) ) as ?to )
+
+  bind( iri( concat( func:getNamespace( ?aspect ), ?aspectBoxName, "_To_", ?operationBoxName ) ) as ?edge )
+}