Merge branch 'main' into 481-samm-cli-aas-generation-mapping-of-set-characteristics

Author: Yauhenikapl

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/Namespace.java

@@ -17,6 +17,7 @@
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.VersionNumber;
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 
 /**
  * Represents the namespace the model elements are contained in
@@ -29,14 +30,28 @@ public interface Namespace extends ModelElementGroup, HasDescription {
 
    /**
     * The package part of the model namespace is an identifier given in
-    * <a href="https://en.wikipedia.org/wiki/Reverse_domain_name_notation">reverse domain name notation</a>, e.g., com.example.myapp.
+    * <a href="https://en.wikipedia.org/wiki/Reverse_domain_name_notation">reverse domain name notation</a>, e.g.,
+    * {@code com.example.myapp}.
     *
     * @return the package part of the namespace
+    * @deprecated use {@link #namespaceMainPart()} instead
     */
-   String packagePart();
+   @Deprecated( forRemoval = true )
+   default String packagePart() {
+      return namespaceMainPart();
+   }
+
+   /**
+    * The package part of the model namespace is an identifier given in
+    * <a href="https://en.wikipedia.org/wiki/Reverse_domain_name_notation">reverse domain name notation</a>, e.g.,
+    * {@code com.example.myapp}.
+    *
+    * @return the package part of the namespace
+    */
+   String namespaceMainPart();
 
    /**
-    * The version part of the namespace. This is always a semantic version, e.g. 1.2.3.
+    * The version part of the namespace. This is always a semantic version, e.g. {@code 1.2.3}.
     *
     * @return the version part
     */
@@ -54,8 +69,8 @@ public interface Namespace extends ModelElementGroup, HasDescription {
     *
     * @return the identifier
     */
-   default String urn() {
-      return String.format( "urn:samm:%s:%s", packagePart(), version() );
+   default AspectModelUrn urn() {
+      return AspectModelUrn.fromUrn( String.format( "urn:samm:%s:%s", namespaceMainPart(), version() ) );
    }
 
    /**

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/RdfUtil.java

@@ -16,6 +16,7 @@
 import static java.util.stream.Collectors.toSet;
 
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.function.Function;
@@ -27,6 +28,9 @@
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
 
 import com.google.common.collect.Streams;
+import org.apache.jena.query.ParameterizedSparqlString;
+import org.apache.jena.query.QueryExecution;
+import org.apache.jena.query.QueryExecutionFactory;
 import org.apache.jena.rdf.model.Literal;
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.ModelFactory;
@@ -140,4 +144,25 @@ public static void cleanPrefixes( final Model model ) {
    public static Model createModel( final String ttlRepresentation ) {
       return TurtleLoader.loadTurtle( ttlRepresentation ).get();
    }
+
+   /**
+    * Returns the List of named resources that transitively point to a given node. Transtively here means that the given node
+    * is reachable from the named resource via any number of anonymous nodes inbetween.
+    *
+    * @param node the target node
+    * @return the list of resources that point to the node
+    */
+   public static List<Resource> getNamedElementsReferringTo( final RDFNode node ) {
+      final ParameterizedSparqlString sparqlString = new ParameterizedSparqlString();
+      sparqlString.setCommandText( "select ?s where { ?s (<>|!<>)* ?node . }" );
+      sparqlString.setParam( "node", node );
+      try ( final QueryExecution queryExecution = QueryExecutionFactory.create( sparqlString.asQuery(), node.getModel() ) ) {
+         return Streams.stream( queryExecution.execSelect() ).flatMap( querySolution -> {
+            final RDFNode subject = querySolution.get( "s" );
+            return subject.isURIResource() && !subject.equals( node )
+                  ? Stream.of( subject.asResource() )
+                  : Stream.empty();
+         } ).toList();
+      }
+   }
 }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/AspectChangeManagerConfig.java

@@ -22,6 +22,8 @@ public record AspectChangeManagerConfig(
       List<String> defaultFileHeader,
       boolean detailedChangeReport
 ) {
+   public static final AspectChangeManagerConfig DEFAULT = AspectChangeManagerConfigBuilder.builder().build();
+
    public AspectChangeManagerConfig {
       if ( defaultFileHeader == null ) {
          defaultFileHeader = List.of();

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/ChangeReport.java

@@ -16,22 +16,75 @@
 import java.util.List;
 import java.util.Map;
 
+import org.apache.jena.rdf.model.Model;
+
 /**
  * A structured representation of a number of {@link Change}s
  */
-public interface ChangeReport {
-   ChangeReport NO_CHANGES = new ChangeReport() {
-   };
+public sealed interface ChangeReport {
+   ChangeReport NO_CHANGES = new NoChanges();
+
+   /**
+    * Indicates that no changes are performed
+    */
+   record NoChanges( ) implements ChangeReport {
+      @Override
+      public <T, C> T accept( final Visitor<T, C> visitor, final C context ) {
+         return visitor.visitNoChanges( this, context );
+      }
+   }
 
+   /**
+    * Simple textual description of a change
+    *
+    * @param text the description text
+    */
    record SimpleEntry( String text ) implements ChangeReport {
+      @Override
+      public <T, C> T accept( final Visitor<T, C> visitor, final C context ) {
+         return visitor.visitSimpleEntry( this, context );
+      }
    }
 
-   record EntryWithDetails( String summary, Map<String, Object> details ) implements ChangeReport {
+   /**
+    * Description of adding/removing parts of RDF models
+    *
+    * @param summary the summary
+    * @param details detailed descriptions of models used for changes
+    */
+   record EntryWithDetails( String summary, Map<String, Model> details ) implements ChangeReport {
+      @Override
+      public <T, C> T accept( final Visitor<T, C> visitor, final C context ) {
+         return visitor.visitEntryWithDetails( this, context );
+      }
    }
 
+   /**
+    * Structures multiple changes with an optional summary
+    *
+    * @param summary the summary
+    * @param entries the nested reports
+    */
    record MultipleEntries( String summary, List<ChangeReport> entries ) implements ChangeReport {
       public MultipleEntries( final List<ChangeReport> entries ) {
          this( null, entries );
       }
+
+      @Override
+      public <T, C> T accept( final Visitor<T, C> visitor, final C context ) {
+         return visitor.visitMultipleEntries( this, context );
+      }
+   }
+
+   <T, C> T accept( Visitor<T, C> visitor, C context );
+
+   interface Visitor<T, C> {
+      T visitNoChanges( NoChanges noChanges, C context );
+
+      T visitSimpleEntry( SimpleEntry simpleEntry, C context );
+
+      T visitEntryWithDetails( EntryWithDetails entryWithDetails, C context );
+
+      T visitMultipleEntries( MultipleEntries multipleEntries, C context );
    }
 }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/ChangeReportFormatter.java

@@ -26,109 +26,110 @@
 /**
  * Takes a {@link ChangeReport} as an input and renders it as a string
  */
-public class ChangeReportFormatter implements BiFunction<ChangeReport, AspectChangeManagerConfig, String> {
+public class ChangeReportFormatter implements ChangeReport.Visitor<String, ChangeReportFormatter.Context>,
+      BiFunction<ChangeReport, AspectChangeManagerConfig, String> {
    public static final ChangeReportFormatter INSTANCE = new ChangeReportFormatter();
 
    private ChangeReportFormatter() {
    }
 
-   private void handleSimpleEntry( final StringBuilder builder, final ChangeReport.SimpleEntry simpleEntry, final String indent ) {
-      builder.append( indent );
-      builder.append( "- " );
-      builder.append( simpleEntry.text() );
-      builder.append( "\n" );
+   public record Context( int indentationLevel, AspectChangeManagerConfig config ) {
+      public Context indent() {
+         return new Context( indentationLevel() + 1, config() );
+      }
    }
 
-   private void handleMultipleEntries( final StringBuilder builder, final ChangeReport.MultipleEntries multipleEntries, final String indent,
-         final int indentationLevel, final AspectChangeManagerConfig config ) {
-      if ( multipleEntries.summary() != null ) {
-         builder.append( indent );
-         builder.append( "- " );
-         builder.append( multipleEntries.summary() );
-         builder.append( "\n" );
-      }
-      final List<ChangeReport> entries = multipleEntries.entries();
-      for ( int i = 0; i < entries.size(); i++ ) {
-         final ChangeReport entry = entries.get( i );
-         final int entryIndentation = multipleEntries.summary() == null
-               ? indentationLevel
-               : indentationLevel + 1;
-         append( builder, entry, config, entryIndentation );
-         if ( i < entries.size() - 1 ) {
-            builder.append( "\n" );
-         }
-      }
+   @Override
+   public String apply( final ChangeReport changeReport, final AspectChangeManagerConfig aspectChangeManagerConfig ) {
+      return changeReport.accept( this, new Context( 0, aspectChangeManagerConfig ) );
+   }
+
+   @Override
+   public String visitNoChanges( final ChangeReport.NoChanges noChanges, final Context context ) {
+      return "";
+   }
+
+   @Override
+   public String visitSimpleEntry( final ChangeReport.SimpleEntry simpleEntry, final Context context ) {
+      return simpleEntry.text();
    }
 
-   private void handleEntryWithDetails( final StringBuilder builder, final ChangeReport.EntryWithDetails entryWithDetails,
-         final String indent, final AspectChangeManagerConfig config ) {
+   @Override
+   public String visitEntryWithDetails( final ChangeReport.EntryWithDetails entryWithDetails, final Context context ) {
+      final String indent = "  ".repeat( context.indentationLevel() );
+      final StringBuilder builder = new StringBuilder();
+
       builder.append( indent );
       builder.append( "- " );
       builder.append( entryWithDetails.summary() );
       builder.append( "\n" );
-      for ( final Map.Entry<String, Object> entry : entryWithDetails.details().entrySet() ) {
-         if ( config.detailedChangeReport() && entry.getValue() instanceof final Model model ) {
+
+      for ( final Map.Entry<String, Model> entry : entryWithDetails.details().entrySet() ) {
+         if ( context.config().detailedChangeReport() ) {
             builder.append( indent );
             builder.append( "  - " );
             builder.append( entry.getKey() );
             builder.append( ": " );
             builder.append( "\n" );
-            show( model ).lines()
+            show( entry.getValue() ).lines()
                   .forEach( line -> {
                      builder.append( indent );
                      builder.append( "    " );
                      builder.append( line );
                      builder.append( "\n" );
                   } );
-         } else if ( !config.detailedChangeReport() && entry.getValue() instanceof final Model model ) {
-            final int numberOfStatements = model.listStatements().toList().size();
+         } else {
+            final int numberOfStatements = entry.getValue().listStatements().toList().size();
+            final int numberOfPrefixes = entry.getValue().getNsPrefixMap().size();
             if ( numberOfStatements > 0 ) {
                builder.append( indent );
                builder.append( "  - " );
                builder.append( entry.getKey() );
                builder.append( ": " );
                builder.append( numberOfStatements );
-               builder.append( " RDF statements" );
+               builder.append( " RDF statements and " );
+               builder.append( numberOfPrefixes );
+               builder.append( " prefixes" );
                builder.append( "\n" );
             }
-         } else {
-            builder.append( indent );
-            builder.append( "  - " );
-            builder.append( entry.getKey() );
-            builder.append( ": " );
-            builder.append( entry.getValue().toString() );
-            builder.append( "\n" );
          }
       }
+
+      return builder.toString();
    }
 
-   private void append( final StringBuilder builder, final ChangeReport report, final AspectChangeManagerConfig config,
-         final int indentationLevel ) {
-      final String indent = "  ".repeat( indentationLevel );
-      if ( report instanceof final ChangeReport.SimpleEntry simpleEntry ) {
-         handleSimpleEntry( builder, simpleEntry, indent );
-      } else if ( report instanceof final ChangeReport.MultipleEntries multipleEntries ) {
-         handleMultipleEntries( builder, multipleEntries, indent, indentationLevel, config );
-      } else if ( report instanceof final ChangeReport.EntryWithDetails entryWithDetails ) {
-         handleEntryWithDetails( builder, entryWithDetails, indent, config );
+   @Override
+   public String visitMultipleEntries( final ChangeReport.MultipleEntries multipleEntries, final Context context ) {
+      final String indent = "  ".repeat( context.indentationLevel() );
+      final StringBuilder builder = new StringBuilder();
+      if ( multipleEntries.summary() != null ) {
+         builder.append( indent );
+         builder.append( "- " );
+         builder.append( multipleEntries.summary() );
+         builder.append( "\n" );
       }
+      final List<ChangeReport> entries = multipleEntries.entries();
+      for ( int i = 0; i < entries.size(); i++ ) {
+         final ChangeReport entry = entries.get( i );
+         final Context nestedContext = multipleEntries.summary() == null ? context : context.indent();
+         builder.append( entry.accept( this, nestedContext ) );
+         if ( i < entries.size() - 1 ) {
+            builder.append( "\n" );
+         }
+      }
+      return builder.toString();
    }
 
    private String show( final Model model ) {
       final Model copy = ModelFactory.createDefaultModel();
       copy.add( model );
-      RdfUtil.cleanPrefixes( copy );
+      if ( !copy.listStatements().toList().isEmpty() ) {
+         RdfUtil.cleanPrefixes( copy );
+      }
       final StringWriter stringWriter = new StringWriter();
       stringWriter.append( "--------------------\n" );
       copy.write( stringWriter, "TURTLE" );
       stringWriter.append( "--------------------\n" );
       return stringWriter.toString();
    }
-
-   @Override
-   public String apply( final ChangeReport changeReport, final AspectChangeManagerConfig config ) {
-      final StringBuilder builder = new StringBuilder();
-      append( builder, changeReport, config, 0 );
-      return builder.toString();
-   }
 }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/AbstractChange.java

@@ -24,7 +24,11 @@ protected String show( final AspectModelFile aspectModelFile ) {
       return show( aspectModelFile.sourceLocation() );
    }
 
+   protected String show( final URI sourceLocation ) {
+      return sourceLocation.toString();
+   }
+
    protected String show( final Optional<URI> sourceLocation ) {
-      return sourceLocation.map( URI::toString ).orElse( "(unknown file)" );
+      return sourceLocation.map( this::show ).orElse( "(unknown file)" );
    }
 }