Merge pull request #712 from bci-oss/666-import-and-export-namespace-packages

Enable import and export of Namepace Packages

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/edit/AspectChangeManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
  * information regarding authorship.
@@ -13,16 +13,25 @@
 
 package org.eclipse.esmf.aspectmodel.edit;
 
+import java.io.File;
+import java.io.IOException;
+import java.net.URI;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.ArrayDeque;
+import java.util.ArrayList;
 import java.util.Deque;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 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.metamodel.AspectModel;
 import org.eclipse.esmf.metamodel.impl.DefaultAspectModel;
 
@@ -38,8 +47,8 @@
  * Note the following points:
  * <ul>
  *    <li>Only one AspectChangeManager must wrap a given AspectModel at any time</li>
- *    <li>All changes are done <i>in-memory</i>. In order to write them to the file system, use the
- *    {@link org.eclipse.esmf.aspectmodel.serializer.AspectSerializer}</li>
+ *    <li>All changes are done <i>in-memory</i>. In order to write them to the file system, use {@link #writeChangesToDisk(WriteConfig)}
+ *    </li>
  *    <li>After performing an {@link #applyChange(Change)}, {@link #undoChange()} or {@link #redoChange()} operation, and until the
  *    next call of one of them, the methods {@link #modifiedFiles()}, {@link #createdFiles()} and {@link #removedFiles()} indicate
  *    corresponding changes in the AspectModel's files.
@@ -185,4 +194,107 @@ public void indicateFileHasChanged( final AspectModelFile file ) {
          fileState.put( file, FileState.CHANGED );
       }
    }
+
+   /**
+    * Syncs all queued changes to the file system. This is the operation that acutally performs operations such as deleting, creating and
+    * writing files.
+    */
+   public synchronized WriteResult writeChangesToDisk( final WriteConfig config ) {
+      final WriteResult writeResult = checkFileSystemConsistency( config );
+      if ( writeResult instanceof WriteResult.PreconditionsNotMet ) {
+         return writeResult;
+      }
+
+      final WriteResult result = performFileSystemWrite();
+      if ( result instanceof WriteResult.Success ) {
+         resetFileStates();
+      }
+      return result;
+   }
+
+   protected WriteResult performFileSystemWrite() {
+      final List<String> messages = new ArrayList<>();
+      removedFiles()
+            .map( fileToRemove -> Paths.get( fileToRemove.sourceLocation().orElseThrow() ).toFile() )
+            .forEach( file -> {
+               try {
+                  Files.delete( file.toPath() );
+               } catch ( final IOException exception ) {
+                  messages.add( "Could not delete file: " + file );
+               }
+            } );
+
+      createdFiles().forEach( fileToCreate -> {
+         final File file = Paths.get( fileToCreate.sourceLocation().orElseThrow() ).toFile();
+         if ( !file.getParentFile().exists() && !file.getParentFile().mkdirs() ) {
+            messages.add( "Target path to write file could not be created: " + file );
+         } else {
+            try {
+               AspectSerializer.INSTANCE.write( fileToCreate );
+            } catch ( final SerializationException exception ) {
+               messages.add( exception.getMessage() );
+            }
+         }
+      } );
+
+      modifiedFiles().forEach( aspectModelFile -> {
+         try {
+            AspectSerializer.INSTANCE.write( aspectModelFile );
+         } catch ( final SerializationException exception ) {
+            messages.add( exception.getMessage() );
+         }
+      } );
+
+      return messages.isEmpty()
+            ? new WriteResult.Success()
+            : new WriteResult.WriteFailure( messages );
+   }
+
+   protected WriteResult checkFileSystemConsistency( final WriteConfig config ) {
+      final List<String> messages = new ArrayList<>();
+      final boolean[] canBeFixedByOverwriting = new boolean[1];
+      removedFiles().map( AspectSerializer.INSTANCE::aspectModelFileUrl ).forEach( url -> {
+         if ( !url.getProtocol().equals( "file" ) ) {
+            messages.add( "File should be removed, but it is not identified by a file: URL: " + url );
+         }
+         final File file = new File( URI.create( url.toString() ) );
+         if ( !file.exists() ) {
+            messages.add( "File should be removed, but it does not exist: " + file );
+         }
+      } );
+
+      createdFiles().map( AspectSerializer.INSTANCE::aspectModelFileUrl ).forEach( url -> {
+         if ( !url.getProtocol().equals( "file" ) ) {
+            messages.add( "New file should be written, but it is not identified by a file: URL: " + url );
+         }
+         final File file = new File( URI.create( url.toString() ) );
+         if ( file.exists() && !config.forceOverwrite() ) {
+            messages.add( "New file should be written, but it already exists: " + file );
+            canBeFixedByOverwriting[0] = true;
+         }
+         if ( file.exists() && config.forceOverwrite() && !file.canWrite() ) {
+            messages.add( "New file should be written, but it is not writable: " + file );
+         }
+      } );
+
+      modifiedFiles().map( AspectSerializer.INSTANCE::aspectModelFileUrl ).forEach( url -> {
+         if ( !url.getProtocol().equals( "file" ) ) {
+            messages.add( "File should be modified, but it is not identified by a file: URL: " + url );
+         }
+         final File file = new File( URI.create( url.toString() ) );
+         if ( !file.exists() ) {
+            messages.add( "File should be modified, but it does not exist: " + file );
+         }
+         if ( !file.canWrite() ) {
+            messages.add( "File should be modified, but it is not writable: " + file );
+         }
+         if ( !file.isFile() ) {
+            messages.add( "File should be modified, but it is not a regular file: " + file );
+         }
+      } );
+
+      return messages.isEmpty()
+            ? new WriteResult.Success()
+            : new WriteResult.PreconditionsNotMet( messages, canBeFixedByOverwriting[0] );
+   }
 }

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

@@ -0,0 +1,26 @@
+/*
+ * 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.aspectmodel.edit;
+
+import io.soabase.recordbuilder.core.RecordBuilder;
+
+/**
+ * Configures the file system writing operation in {@link AspectChangeManager}
+ *
+ * @param forceOverwrite determines whether existing files should be overwritten
+ */
+@RecordBuilder
+public record WriteConfig(
+      boolean forceOverwrite
+) {}

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

@@ -0,0 +1,57 @@
+/*
+ * 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.aspectmodel.edit;
+
+import java.util.List;
+
+/**
+ * Represents the result of the operation of writing changes in the {@link AspectChangeManager} to the file system.
+ */
+public sealed interface WriteResult {
+   interface Visitor<T> {
+      T visitSuccess( Success success );
+
+      T visitWriteFailure( WriteFailure failure );
+
+      T visitPreconditionsNotMet( PreconditionsNotMet preconditionsNotMet );
+   }
+
+   <T> T accept( Visitor<T> visitor );
+
+   record PreconditionsNotMet(
+         List<String> errorMessages,
+         boolean canBeFixedByOverwriting
+   ) implements WriteResult {
+      @Override
+      public <T> T accept( final Visitor<T> visitor ) {
+         return visitor.visitPreconditionsNotMet( this );
+      }
+   }
+
+   record WriteFailure(
+         List<String> errorMessages
+   ) implements WriteResult {
+      @Override
+      public <T> T accept( final Visitor<T> visitor ) {
+         return visitor.visitWriteFailure( this );
+      }
+   }
+
+   final class Success implements WriteResult {
+      @Override
+      public <T> T accept( final Visitor<T> visitor ) {
+         return visitor.visitSuccess( this );
+      }
+   }
+}