Simplify AspectModelFile API (include filename() method)

Author: atextor

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

@@ -17,6 +17,7 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.metamodel.ModelElement;
 import org.eclipse.esmf.metamodel.ModelElementGroup;
 import org.eclipse.esmf.metamodel.Namespace;
@@ -68,6 +69,25 @@ default Optional<String> spdxLicenseIdentifier() {
     */
    Optional<URI> sourceLocation();
 
+   /**
+    * Returns the local file name ("something.ttl") of this AspectModelFile, based on its source location.
+    *
+    * @return the local Aspect Model file
+    */
+   default Optional<String> filename() {
+      return sourceLocation().flatMap( uri -> {
+         final String path = uri.toString();
+         if ( !path.contains( "/" ) ) {
+            return Optional.empty();
+         }
+         final String filename = path.substring( path.lastIndexOf( "/" ) + 1 );
+         if ( filename.endsWith( ".ttl" ) && filename.length() >= 5 ) {
+            return Optional.of( filename );
+         }
+         return Optional.empty();
+      } );
+   }
+
    /**
     * Returns the {@link Namespace} this AspectModelFile is a part of
     *
@@ -77,6 +97,15 @@ default Namespace namespace() {
       throw new UnsupportedOperationException( "Uninitialized Aspect Model" );
    }
 
+   /**
+    * Returns the URN of the namespace of this file
+    *
+    * @return the namespace URN
+    */
+   default AspectModelUrn namespaceUrn() {
+      return namespace().urn();
+   }
+
    /**
     * Lists the model elements that are contained in this AspectModelFile
     *

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

@@ -14,6 +14,7 @@
 package org.eclipse.esmf.aspectmodel.resolver;
 
 import java.net.URI;
+import java.util.Iterator;
 import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
@@ -22,7 +23,7 @@
 /**
  * A model source is one place where {@link AspectModelFile}s are stored and can be retrieved from.
  */
-public interface ModelSource {
+public interface ModelSource extends Iterable<AspectModelFile> {
    /**
     * Lists all URIs of Aspect Model files in this model source
     *
@@ -52,4 +53,14 @@ public interface ModelSource {
     * @return the Aspect Model files
     */
    Stream<AspectModelFile> loadContentsForNamespace( AspectModelUrn namespace );
+
+   /**
+    * Makes the contents of this model sources iterable
+    *
+    * @return an iterator for the AspectModelFiles in this model source
+    */
+   @Override
+   default Iterator<AspectModelFile> iterator() {
+      return loadContents().iterator();
+   }
 }

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

@@ -39,12 +39,14 @@
 import org.eclipse.esmf.aspectmodel.resolver.exceptions.ModelResolutionException;
 import org.eclipse.esmf.aspectmodel.resolver.modelfile.RawAspectModelFile;
 import org.eclipse.esmf.aspectmodel.serializer.AspectSerializer;
+import org.eclipse.esmf.aspectmodel.serializer.SerializationException;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.aspectmodel.versionupdate.MetaModelVersionMigrator;
 import org.eclipse.esmf.metamodel.AspectModel;
 import org.eclipse.esmf.metamodel.Namespace;
 
 import com.google.common.collect.ImmutableList;
+import lombok.Getter;
 import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -61,6 +63,7 @@ public class NamespacePackage implements ResolutionStrategy, Artifact<URI, byte[
    private static final String ASPECT_MODELS_FOLDER = "aspect-models";
 
    // Fields that are always set
+   @Getter
    private final String modelsRoot;
    private final List<AspectModelFile> files;
 
@@ -261,19 +264,7 @@ private void addFile( final ZipOutputStream zipOutputStream, final String path,
    }
 
    private String outputFileName( final AspectModelFile aspectModelFile ) {
-      return aspectModelFile.sourceLocation()
-            .flatMap( uri -> {
-               final String path = uri.toString();
-               if ( !path.contains( "/" ) ) {
-                  return Optional.empty();
-               }
-               final String filename = path.substring( path.lastIndexOf( "/" ) + 1 );
-               if ( filename.endsWith( ".ttl" ) && filename.length() >= 5 ) {
-                  return Optional.of( filename );
-               }
-               return Optional.empty();
-            } )
-            .orElseGet( () -> "definitions" + aspectModelFile.hashCode() + ".ttl" );
+      return aspectModelFile.filename().orElseGet( () -> "definitions" + aspectModelFile.hashCode() + ".ttl" );
    }
 
    @Override
@@ -304,10 +295,21 @@ public byte[] serialize() {
                addFile( out, filePath, fileContent );
             }
          }
-      } catch ( final IOException e ) {
-         throw new RuntimeException( e );
+      } catch ( final IOException exception ) {
+         throw new SerializationException( exception );
       }
 
       return buffer.toByteArray();
    }
+
+   /**
+    * Returns the location of the namespace package, if it was created from an external location. If it was created from an in-memory
+    * {@link AspectModel}, the returned location is null.
+    *
+    * @return the location if set, or null
+    */
+   @SuppressWarnings( { "LombokGetterMayBeUsed", "RedundantSuppression" } )
+   public URI getLocation() {
+      return location;
+   }
 }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/modelfile/DefaultAspectModelFile.java

@@ -22,13 +22,20 @@
 import org.eclipse.esmf.metamodel.ModelElement;
 import org.eclipse.esmf.metamodel.Namespace;
 
+import lombok.Setter;
 import org.apache.jena.rdf.model.Model;
 
+/**
+ * Default implementation of an AspectModelFile that not only provides access to the underlying RDF graph but also the object representation
+ * of the model elements in this file
+ */
 public final class DefaultAspectModelFile implements AspectModelFile {
    private final Model sourceModel;
    private final List<String> headerComment;
    private final Optional<URI> sourceLocation;
+   @Setter
    private List<ModelElement> elements;
+   @Setter
    private Namespace namespace = null;
 
    public DefaultAspectModelFile( final Model sourceModel, final List<String> headerComment, final Optional<URI> sourceLocation ) {
@@ -68,14 +75,6 @@ public Namespace namespace() {
       return namespace;
    }
 
-   public void setElements( final List<ModelElement> elements ) {
-      this.elements = elements;
-   }
-
-   public void setNamespace( final Namespace namespace ) {
-      this.namespace = namespace;
-   }
-
    @Override
    public boolean equals( final Object obj ) {
       if ( obj == this ) {

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/modelfile/MetaModelFile.java

@@ -75,9 +75,11 @@ public enum MetaModelFileType {
    @Getter
    private final MetaModelFileType metaModelFileType;
    private final Model sourceModel;
+   private final String filename;
 
    MetaModelFile( final String section, final String filename, final RdfNamespace rdfNamespace,
          final MetaModelFileType metaModelFileType ) {
+      this.filename = filename;
       this.rdfNamespace = rdfNamespace;
       this.metaModelFileType = metaModelFileType;
       sourceModel = TurtleLoader.loadTurtle( url( section, filename ) )
@@ -147,6 +149,11 @@ public Optional<URI> sourceLocation() {
       return Optional.of( URI.create( rdfNamespace.getUri() ) );
    }
 
+   @Override
+   public Optional<String> filename() {
+      return Optional.of( filename );
+   }
+
    public static List<MetaModelFile> getElementDefinitionsFiles() {
       return Arrays.stream( values() ).filter( file -> file.metaModelFileType == MetaModelFileType.ELEMENT_DEFINITION ).toList();
    }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/modelfile/RawAspectModelFile.java

@@ -18,6 +18,8 @@
 import java.util.Optional;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.ModelResolutionException;
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 
 import io.soabase.recordbuilder.core.RecordBuilder;
 import org.apache.jena.rdf.model.Model;
@@ -55,4 +57,10 @@ public record RawAspectModelFile(
    public String toString() {
       return sourceLocation().map( URI::toString ).orElse( "(unknown file)" );
    }
+
+   @Override
+   public AspectModelUrn namespaceUrn() {
+      return AspectModelUrn.from( sourceModel().getNsPrefixMap().get( "" ).replace( "#", "" ) )
+            .getOrElseThrow( () -> new ModelResolutionException( "Aspect Model File " + this + " does not contain a '@prefix :'" ) );
+   }
 }