Merge branch 'main' into 2.2.x

Author: atextor

AUTHORS.md

@@ -1,19 +1,19 @@
-# Authors 
+# Authors
 
 The following people have contributed to this repository:
 
 * Birgit Boss, Robert Bosch GmbH
 * Daniel Ewert, Robert Bosch GmbH, [email protected]
-* Dennis Melzer, Robert Bosch GmbH, georg.schmidt-dumont@de.bosch.com
+* Dennis Melzer, Robert Bosch GmbH, Dennis.Melzer@de.bosch.com
 * Misecka Rastislav, Systecs Informationssysteme GmbH
 * Fethuallah Misir, Robert Bosch GmbH, [email protected]
 * Michele Santoro
 * Andreas Schilling, [email protected]
-* Georg Schmidt-Dumont, Robert Bosch GmbH, [email protected] 
-* David Schmitt, Systecs Informationssysteme GmbH
+* Georg Schmidt-Dumont, Robert Bosch GmbH, [email protected]
+* David Schmitt, Robert Bosch GmbH, [email protected]
 * Andreas Textor, [email protected]
 * Peter Triebe, [email protected]
-* Julian Walbrecht,  ulian[email protected]
+* Julian Walbrecht, Julian[email protected]
 * Sven Walter, [email protected]
 * Sven Erik Jeroschewski, Bosch.IO GmbH
 * Lukas Römer, Bosch.IO GmbH, [email protected]

README.md

@@ -11,7 +11,7 @@
     - [esmf-aspect-static-meta-model](#esmf-aspect-static-meta-model)
     - [esmf-aspect-model-validator](#esmf-aspect-model-validator)
 - [Version Handling](#version-handling)
-    - [SAMM Versioning](#samm-versioning)
+    - [esmf-sdk Versioning](#esmf-sdk-versioning)
     - [SAMM Java Implementation Packaging](#samm-java-implementation-packaging)
 - [SAMM CLI](#samm-cli)
 - [Artifact Generation facilities](#artifact-generation-facilities)
@@ -37,17 +37,18 @@ code generators, validators etc.
 This document provides an overall overview of the SDK, and the concepts applied throughout it.
 Detailed documentation and concepts for each component can be found in the respective subfolders.
 
-This repository contains a detailed developer documentation written in AsciiDoc. The source files
-(AsciiDoc) are located [here](documentation/developer-guide) and are built using
-[Antora](https://antora.org/) which generates the documentation as HTML files.
+This repository contains a detailed developer documentation written in AsciiDoc. 
+The source files (AsciiDoc) are located [here](documentation/developer-guide) and are built using
+[Antora](https://antora.org/) which generates the documentation as HTML files. A site generated using Antora is self-contained and can be viewed entirely offline via a web browser without setting up a web server.
+To build the documentation locally, please check out and follow the instructions in [ESMF documentation repository](https://github.com/eclipse-esmf/eclipse-esmf.github.io).
 
 ## Getting help
 
 Are you having trouble with ESMF SDK? We want to help!
 
-* Check the [ESMF SDK developer documentation](https://openmanufacturingplatform.github.io/sds-documentation/sds-developer-guide/index.html)
+* Check the [ESMF SDK developer documentation](https://eclipse-esmf.github.io/esmf-developer-guide/index.html)
 * Ask a question the [community forum](https://www.eclipse.org/forums/index.php/f/617/).
-* Check the SAMM [specification](https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/snapshot/index.html)
+* Check the SAMM [specification](https://eclipse-esmf.github.io/samm-specification/snapshot/index.html)
 * Having issues with the ESMF SDK? Open a [GitHub issue](https://github.com/eclipse-esmf/esmf-sdk/issues).
 
 ## Build and contribute
@@ -124,30 +125,27 @@ The model validator is also available through the [SAMM CLI](#samm-cli).
 
 ## Version Handling
 
-SAMM does evolve over time. While measures are made to do this in a non-breaking manner, some
-changes cannot be carried out without the need to define a new, breaking version. Due to this fact
-it is important to understand the versioning concept that is applied to the SAMM, APIs and SDK
+SAMM and its SDKs evolve over time. While measures are taken to do this in a non-breaking manner,
+some changes cannot be carried out without the need to define a new, breaking version. Due to this
+fact it is important to understand the versioning concept that is applied to the SAMM, APIs and SDK
 components that are derived from them.
 
-In case of a prerelease there will be a postfix added and it will be released on Github. The way to
-access the artifact is described in [Github-Installing a
-package](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#installing-a-package)
+In case of a prerelease a postfix will be added to the version, such as `-M1`, and it will be
+released on Github. The way to access the artifact is described in the [Java Aspect Tooling
+Guide](https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/java-aspect-tooling.html#versioning).
 
-### SAMM Versioning
+### esmf-sdk Versioning
 
-For SAMM, semantic versioning (`major.minor.micro`) is applied with the following rules:
+For the esmf-sdk, semantic versioning (`major.minor.micro`) is applied with the following rules:
 
-* A breaking change increases the `major` part
-* Backwards compatible new features increase the `minor` part
-* Changes to existing features or bug fixes increase the `micro` part
+* The `major` part designates the supported SAMM major version
+* A breaking change increases the `minor` part
+* Backwards compatible new features, changes to existing features or bugfixes increase the `minor` part
 
-A new SAMM version always comprises new releases of the SDK components that depend on SAMM, however
-not the other way round. New releases of SDK components may be crafted that are built on the
+A new SAMM version implies new releases of the SDK components that depend on this SAMM version,
+however not the other way round. New releases of SDK components may be released that are built on an
 existing SAMM version.
 
-The SDK component versions are otherwise not tied to the SAMM version, i.e., they may differ in any
-part of the version.
-
 ### SAMM Java Implementation Packaging
 
 Complex applications might have the need to be implemented against different versions of the SAMM,
@@ -238,7 +236,7 @@ GitHub](https://github.com/eclipse-esmf/esmf-sdk/releases).
 
 For information regarding running the command line tool, the available commands and their
 description, please have a look at the
-[documentation](https://openmanufacturingplatform.github.io/sds-documentation/sds-developer-guide/tooling-guide/bamm-cli.html).
+[documentation](https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/samm-cli.html).
 
 ## License
 

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

@@ -13,23 +13,13 @@
 
 package org.eclipse.esmf.metamodel;
 
-import java.util.Collections;
-import java.util.List;
-
 /**
  * Represents a generic domain specific concept which may have multiple specific variants.
  *
  * @since SAMM 2.0.0
  */
 public interface AbstractEntity extends ComplexType {
 
-   /**
-    * @return a {@link java.util.List} of {@link ComplexType}s which extend this Abstract Entity
-    */
-   default List<ComplexType> getExtendingElements() {
-      return Collections.emptyList();
-   }
-
    @Override
    default boolean isAbstractEntity() {
       return true;

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

@@ -14,6 +14,7 @@
 package org.eclipse.esmf.metamodel;
 
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Collectors;
@@ -24,6 +25,13 @@
  */
 public interface ComplexType extends Type, StructureElement {
 
+   /**
+    * @return a {@link java.util.List} of {@link ComplexType}s which extend this Entity
+    */
+   default List<ComplexType> getExtendingElements() {
+      return Collections.emptyList();
+   }
+   
    default boolean isAbstractEntity() {
       return false;
    }

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

@@ -53,7 +53,7 @@ default boolean isOptional() {
     *       By default Properties are included in the runtime data.
     *
     * @see
-    * <a href="https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/modeling-guidelines.html#declaring-enumerations">BAMM Aspect Meta Model
+    * <a href="https://eclipse-esmf.github.io/samm-specification/2.0.0/modeling-guidelines.html#declaring-enumerations">Semantic Aspect Meta Model
     *       Specification - Declaring Enumerations</a>
     * @since SAMM 1.0.0
     */

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/impl/DefaultAbstractEntity.java

@@ -14,46 +14,31 @@
 package org.eclipse.esmf.metamodel.impl;
 
 import java.util.List;
-import java.util.Objects;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.metamodel.AbstractEntity;
 import org.eclipse.esmf.metamodel.ComplexType;
 import org.eclipse.esmf.metamodel.Property;
 import org.eclipse.esmf.metamodel.loader.MetaModelBaseAttributes;
+import org.eclipse.esmf.metamodel.loader.ModelElementFactory;
 import org.eclipse.esmf.metamodel.visitor.AspectVisitor;
 
 public class DefaultAbstractEntity extends DefaultComplexType implements AbstractEntity {
-
-   private final List<AspectModelUrn> extendingElements;
-
    public static DefaultAbstractEntity createDefaultAbstractEntity(
          final MetaModelBaseAttributes metaModelBaseAttributes,
          final List<? extends Property> properties,
          final Optional<ComplexType> _extends,
          final List<AspectModelUrn> extendingElements ) {
-      final DefaultAbstractEntity defaultAbstractEntity = new DefaultAbstractEntity( metaModelBaseAttributes, properties, _extends, extendingElements );
-      instances.put( metaModelBaseAttributes.getUrn().get(), defaultAbstractEntity );
-      return defaultAbstractEntity;
+      return new DefaultAbstractEntity( metaModelBaseAttributes, properties, _extends, extendingElements, null );
    }
 
-   private DefaultAbstractEntity( final MetaModelBaseAttributes metaModelBaseAttributes,
+   public DefaultAbstractEntity( final MetaModelBaseAttributes metaModelBaseAttributes,
          final List<? extends Property> properties,
          final Optional<ComplexType> _extends,
-         final List<AspectModelUrn> extendingElements ) {
-      super( metaModelBaseAttributes, properties, _extends );
-      this.extendingElements = extendingElements;
-   }
-
-   /**
-    * @return all {@link ComplexType} instances from the {@link DefaultComplexType#instances} Map which extend this
-    *       Abstract Entity.
-    */
-   @Override
-   public List<ComplexType> getExtendingElements() {
-      return extendingElements.stream().map( instances::get ).filter( Objects::nonNull ).collect( Collectors.toList() );
+         final List<AspectModelUrn> extendingElements,
+         final ModelElementFactory loadedElements ) {
+      super( metaModelBaseAttributes, properties, _extends, extendingElements, loadedElements );
    }
 
    /**

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/impl/DefaultComplexType.java

@@ -14,42 +14,33 @@
 package org.eclipse.esmf.metamodel.impl;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 import java.util.Optional;
-import java.util.WeakHashMap;
 
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
-import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.metamodel.ComplexType;
 import org.eclipse.esmf.metamodel.Property;
 import org.eclipse.esmf.metamodel.loader.MetaModelBaseAttributes;
+import org.eclipse.esmf.metamodel.loader.ModelElementFactory;
 import org.eclipse.esmf.metamodel.visitor.AspectVisitor;
 
 public class DefaultComplexType extends ModelElementImpl implements ComplexType {
-
-   /**
-    * Used to keep track of all {@link ComplexType} instances regardles of whether they are directly or indirectly
-    * referenced in the {@link Aspect}.
-    */
-   protected static WeakHashMap<AspectModelUrn, ComplexType> instances = new WeakHashMap<>();
-
    private final List<Property> properties;
    private final Optional<ComplexType> _extends;
+   private final List<AspectModelUrn> extendingElements;
+   private final ModelElementFactory loadedElements;
 
-   protected static DefaultComplexType createDefaultComplexType( final MetaModelBaseAttributes metaModelBaseAttributes,
-         final List<? extends Property> properties, final Optional<ComplexType> _extends ) {
-      final DefaultComplexType defaultComplexType = new DefaultComplexType( metaModelBaseAttributes, properties, _extends );
-      instances.put( metaModelBaseAttributes.getUrn().get(), defaultComplexType );
-      return defaultComplexType;
-   }
-
-   protected DefaultComplexType( final MetaModelBaseAttributes metaModelBaseAttributes, final List<? extends Property> properties,
-         final Optional<ComplexType> _extends ) {
+   protected DefaultComplexType(
+         final MetaModelBaseAttributes metaModelBaseAttributes,
+         final List<? extends Property> properties,
+         final Optional<ComplexType> _extends,
+         final List<AspectModelUrn> extendingElements,
+         final ModelElementFactory loadedElements ) {
       super( metaModelBaseAttributes );
       this.properties = new ArrayList<>( properties );
       this._extends = _extends;
+      this.extendingElements = extendingElements;
+      this.loadedElements = loadedElements;
    }
 
    /**
@@ -67,8 +58,15 @@ public Optional<ComplexType> getExtends() {
       return _extends;
    }
 
-   public static Map<AspectModelUrn, ComplexType> getInstances() {
-      return Collections.unmodifiableMap( instances );
+   /**
+    * @return all {@link ComplexType} instances which extend this Abstract Entity.
+    */
+   @Override
+   public List<ComplexType> getExtendingElements() {
+      if ( loadedElements == null ) {
+         throw new RuntimeException( "No inheritance information is available." );
+      }
+      return loadedElements.getExtendingElements( extendingElements );
    }
 
    @Override

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/impl/DefaultEntity.java

@@ -12,28 +12,38 @@
  */
 package org.eclipse.esmf.metamodel.impl;
 
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.metamodel.ComplexType;
 import org.eclipse.esmf.metamodel.Entity;
 import org.eclipse.esmf.metamodel.Property;
 import org.eclipse.esmf.metamodel.loader.MetaModelBaseAttributes;
+import org.eclipse.esmf.metamodel.loader.ModelElementFactory;
 import org.eclipse.esmf.metamodel.visitor.AspectVisitor;
 
 public class DefaultEntity extends DefaultComplexType implements Entity {
 
    public static DefaultEntity createDefaultEntity( final MetaModelBaseAttributes metaModelBaseAttributes,
          final List<? extends Property> properties, final Optional<ComplexType> _extends ) {
-      final DefaultEntity defaultEntity = new DefaultEntity( metaModelBaseAttributes, properties, _extends );
-      instances.put( metaModelBaseAttributes.getUrn().get(), defaultEntity );
-      return defaultEntity;
+      return new DefaultEntity( metaModelBaseAttributes, properties, _extends, Collections.emptyList(), null );
    }
 
-   private DefaultEntity( final MetaModelBaseAttributes metaModelBaseAttributes,
+   public DefaultEntity(
+         final MetaModelBaseAttributes metaModelBaseAttributes,
+         final List<? extends Property> properties ) {
+      this( metaModelBaseAttributes, properties, Optional.empty(), Collections.emptyList(), null );
+   }
+
+   public DefaultEntity(
+         final MetaModelBaseAttributes metaModelBaseAttributes,
          final List<? extends Property> properties,
-         final Optional<ComplexType> _extends ) {
-      super( metaModelBaseAttributes, properties, _extends );
+         final Optional<ComplexType> _extends,
+         final List<AspectModelUrn> extendingElements,
+         final ModelElementFactory loadedElements ) {
+      super( metaModelBaseAttributes, properties, _extends, extendingElements, loadedElements );
    }
 
    /**

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/loader/AspectModelLoader.java

@@ -27,29 +27,27 @@
 import org.apache.jena.rdf.model.Resource;
 import org.apache.jena.rdf.model.Statement;
 import org.apache.jena.vocabulary.RDF;
+import org.eclipse.esmf.aspectmodel.UnsupportedVersionException;
+import org.eclipse.esmf.aspectmodel.resolver.AspectModelResolver;
 import org.eclipse.esmf.aspectmodel.resolver.FileSystemStrategy;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidModelException;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidNamespaceException;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidRootElementCountException;
+import org.eclipse.esmf.aspectmodel.resolver.services.VersionedModel;
+import org.eclipse.esmf.aspectmodel.versionupdate.MigratorService;
 import org.eclipse.esmf.aspectmodel.vocabulary.SAMM;
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.metamodel.AspectContext;
 import org.eclipse.esmf.metamodel.ModelElement;
 import org.eclipse.esmf.metamodel.ModelNamespace;
 import org.eclipse.esmf.metamodel.NamedElement;
 import org.eclipse.esmf.metamodel.impl.DefaultModelNamespace;
+import org.eclipse.esmf.samm.KnownVersion;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.google.common.collect.ImmutableSet;
 
-import org.eclipse.esmf.samm.KnownVersion;
-import org.eclipse.esmf.aspectmodel.UnsupportedVersionException;
-import org.eclipse.esmf.aspectmodel.resolver.AspectModelResolver;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidModelException;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidNamespaceException;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidRootElementCountException;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidVersionException;
-import org.eclipse.esmf.aspectmodel.resolver.services.VersionedModel;
-import org.eclipse.esmf.aspectmodel.versionupdate.MigratorService;
-
 import io.vavr.control.Try;
 
 /**
@@ -218,7 +216,7 @@ public static Aspect getSingleAspectUnchecked( final VersionedModel versionedMod
          throw new AspectLoadingException( cause );
       } );
    }
-
+   
    /**
     * Similar to {@link #getSingleAspect(VersionedModel)}, except that a predicate can be provided to select which of potentially
     * multiple aspects should be selected
@@ -228,7 +226,7 @@ public static Aspect getSingleAspectUnchecked( final VersionedModel versionedMod
     */
    public static Try<Aspect> getSingleAspect( final VersionedModel versionedModel, final Predicate<Aspect> selector ) {
       return getAspects( versionedModel ).flatMap( allAspects -> {
-         final List<Aspect> aspects = allAspects.stream().filter( selector::test ).toList();
+         final List<Aspect> aspects = allAspects.stream().filter( selector ).toList();
          return switch ( aspects.size() ) {
             case 1 -> Try.success( aspects.iterator().next() );
             case 0 -> Try.failure( new InvalidRootElementCountException( "No Aspects were found in the model" ) );