Merge branch 'main' into extend-aspect-to-aas-output-file-path-description

Author: atextor

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

@@ -56,7 +56,8 @@ static Map<String, String> createPrefixMap( final KnownVersion metaModelVersion
       result.put( samm.getShortForm(), samm.getNamespace() );
       final SAMMC sammc = new SAMMC( metaModelVersion );
       result.put( sammc.getShortForm(), sammc.getNamespace() );
-      result.put( "samm-e", new SAMME( metaModelVersion, samm ).getNamespace() );
+      final SAMME samme = new SAMME( metaModelVersion, samm );
+      result.put( samme.getShortForm(), samme.getNamespace() );
       final UNIT unit = new UNIT( metaModelVersion, samm );
       result.put( unit.getShortForm(), unit.getNamespace() );
       result.put( "rdf", RDF.getURI() );

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

@@ -13,6 +13,8 @@
 
 package org.eclipse.esmf.metamodel.vocabulary;
 
+import java.util.stream.Stream;
+
 import org.eclipse.esmf.samm.KnownVersion;
 
 /**
@@ -23,4 +25,13 @@ public class SammNs {
    public static final SAMMC SAMMC = new SAMMC( KnownVersion.getLatest() );
    public static final SAMME SAMME = new SAMME( KnownVersion.getLatest(), SAMM );
    public static final UNIT UNIT = new UNIT( KnownVersion.getLatest(), SAMM );
+
+   /**
+    * All SAMM-specific metamodel RDF namespaces
+    *
+    * @return the namespaces
+    */
+   public static Stream<RdfNamespace> sammNamespaces() {
+      return Stream.of( SAMM, SAMMC, SAMME, UNIT );
+   }
 }

core/esmf-aspect-meta-model-java/pom.xml

@@ -28,6 +28,11 @@
    <name>ESMF Aspect Meta Model Java</name>
    <packaging>jar</packaging>
 
+   <properties>
+      <!-- Necessary so that properties-maven-plugin writes it into app.properties -->
+      <project-version>${project.version}</project-version>
+   </properties>
+
    <dependencies>
       <dependency>
          <groupId>org.eclipse.esmf</groupId>
@@ -79,12 +84,30 @@
 
    <build>
       <plugins>
+         <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>properties-maven-plugin</artifactId>
+            <executions>
+               <execution>
+                  <phase>initialize</phase>
+                  <goals>
+                     <goal>write-project-properties</goal>
+                  </goals>
+                  <configuration>
+                     <outputFile>
+                        ${project.build.outputDirectory}/app.properties
+                     </outputFile>
+                  </configuration>
+               </execution>
+            </executions>
+         </plugin>
+
          <plugin>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>build-helper-maven-plugin</artifactId>
             <executions>
                <execution>
-                  <id>add-shared-test-source</id>
+                  <id>add-shared-test-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-test-source</goal>
@@ -96,7 +119,7 @@
                   </configuration>
                </execution>
                <execution>
-                  <id>add-source</id>
+                  <id>add-generated-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-source</goal>
@@ -108,7 +131,7 @@
                   </configuration>
                </execution>
                <execution>
-                  <id>add-src-buildtime-source</id>
+                  <id>add-buildtime-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-source</goal>

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/GenerateBuildtimeCode.java

@@ -31,7 +31,8 @@ public static void main( final String[] args ) {
 
       Stream.of(
             new GenerateUnits( srcBuildtimePath, srcGenPath ),
-            new GenerateQuantityKinds( srcBuildtimePath, srcGenPath )
+            new GenerateQuantityKinds( srcBuildtimePath, srcGenPath ),
+            new GenerateVersionInfo( srcBuildtimePath, srcGenPath )
       ).forEach( BuildtimeCodeGenerator::writeGeneratedFile );
    }
 }

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/GenerateVersionInfo.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2025 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.buildtime;
+
+import java.io.InputStream;
+import java.nio.file.Path;
+import java.util.Properties;
+
+/**
+ * Generates the static version info class
+ */
+public class GenerateVersionInfo extends BuildtimeCodeGenerator {
+   private final Properties properties;
+
+   protected GenerateVersionInfo( final Path srcBuildTimePath, final Path srcGenPath ) {
+      super( srcBuildTimePath, srcGenPath, "VersionInfo", "org.eclipse.esmf.aspectmodel" );
+
+      try ( final InputStream stream = GenerateVersionInfo.class.getClassLoader().getResourceAsStream( "app.properties" ) ) {
+         if ( stream == null ) {
+            throw new RuntimeException();
+         }
+         properties = new Properties();
+         properties.load( stream );
+      } catch ( final Exception exception ) {
+         throw new RuntimeException( "Could not load app.properties" );
+      }
+   }
+
+   @Override
+   protected String interpolateVariable( final String variableName ) {
+      return switch ( variableName ) {
+         case "esmfSdkVersion" -> properties.getProperty( "project-version" );
+         case "aspectMetaModelVersion" -> properties.getProperty( "aspect-meta-model-version" );
+         case "generator" -> getClass().getCanonicalName();
+         default -> throw new RuntimeException( "Unexpected variable in template: " + variableName );
+      };
+   }
+}

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/template/VersionInfo.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2025 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.buildtime.template;
+
+import javax.annotation.processing.Generated;
+
+@Generated( "${generator}" )
+public class VersionInfo {
+   public static final String ESMF_SDK_VERSION = "${esmfSdkVersion}";
+   public static final String ASPECT_META_MODEL_VERSION = "${aspectMetaModelVersion}";
+}

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

@@ -39,7 +39,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * The AspectChangeManager is the central place to to changes/edits/refactorings of an {@link AspectModel}. The AspectChangeManager
+ * The AspectChangeManager is the central place to perform changes/edits/refactorings of an {@link AspectModel}. The AspectChangeManager
  * wraps an AspectModel and allows applying instances of the {@link Change} class using the {@link #applyChange(Change)} method.
  * Calling this method returns a {@link ChangeReport} that describes the performed changes in a structured way. Use the
  * {@link ChangeReportFormatter} to render the ChangeReport to a structured string representation.
@@ -67,6 +67,12 @@ private enum FileState {
       CREATED, CHANGED, REMOVED
    }
 
+   /**
+    * Apply the change manager using an explicit configuration and the target Aspect Model to perform changes on
+    *
+    * @param config the configuration
+    * @param aspectModel the target Aspect Model
+    */
    public AspectChangeManager( final AspectChangeManagerConfig config, final AspectModel aspectModel ) {
       this.config = config;
       resetFileStates();
@@ -77,10 +83,31 @@ public AspectChangeManager( final AspectChangeManagerConfig config, final Aspect
       }
    }
 
+   /**
+    * Apply the change manager to a given target Aspect Model, using the default configuration
+    *
+    * @param aspectModel the target Aspect Model
+    */
    public AspectChangeManager( final AspectModel aspectModel ) {
       this( AspectChangeManagerConfigBuilder.builder().build(), aspectModel );
    }
 
+   /**
+    * Apply the change manager to a new, empty Aspect Model using the given configuration
+    *
+    * @param config the configuration
+    */
+   public AspectChangeManager( final AspectChangeManagerConfig config ) {
+      this( config, new AspectModelLoader().emptyModel() );
+   }
+
+   /**
+    * Apply the change manager to a new, empty Aspect Model using the default configuration
+    */
+   public AspectChangeManager() {
+      this( AspectChangeManagerConfigBuilder.builder().build() );
+   }
+
    public synchronized ChangeReport applyChange( final Change change ) {
       resetFileStates();
       final ChangeReport result = change.fire( this );

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

@@ -18,7 +18,7 @@
 import java.util.List;
 
 /**
- * A Change that groups other changes
+ * A {@link Change} that groups other changes
  */
 public class ChangeGroup implements Change {
    private final String summary;

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

@@ -21,15 +21,16 @@
 import org.eclipse.esmf.metamodel.impl.DefaultProperty;
 
 public class DefaultPropertyWrapper extends DefaultProperty {
-   private DefaultProperty property;
+   private Property property;
+   private String payloadName;
 
-   public DefaultPropertyWrapper( MetaModelBaseAttributes metaModelBaseAttributes ) {
+   public DefaultPropertyWrapper( final MetaModelBaseAttributes metaModelBaseAttributes ) {
       super( metaModelBaseAttributes, null, null, false, false, null, false, null );
    }
 
    @Override
    public String getPayloadName() {
-      return property.getPayloadName();
+      return payloadName != null ? payloadName : property.getPayloadName();
    }
 
    @Override
@@ -75,7 +76,11 @@ public int hashCode() {
       return property.hashCode();
    }
 
-   public void setProperty( DefaultProperty property ) {
+   public void setProperty( final Property property ) {
       this.property = property;
    }
+
+   public void setPayloadName( String payloadName ) {
+      this.payloadName = payloadName;
+   }
 }

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

@@ -127,6 +127,18 @@ public static class Builder {
       private boolean isAnonymous = true;
       private AspectModelFile sourceFile;
 
+      public Builder fromModelElement( final ModelElement modelElement ) {
+         if ( !modelElement.isAnonymous() ) {
+            withUrn( modelElement.urn() );
+         }
+         isAnonymous( modelElement.isAnonymous() );
+         withPreferredNames( modelElement.getPreferredNames() );
+         withDescriptions( modelElement.getDescriptions() );
+         withSee( modelElement.getSee() );
+         withSourceFile( modelElement.getSourceFile() );
+         return this;
+      }
+
       public Builder withUrn( final String urn ) {
          return withUrn( AspectModelUrn.fromUrn( urn ) );
       }