Implement exports

Fix: #60

checkstyle-filter.xml

@@ -12,4 +12,8 @@
   <!-- Seems unavoidable. -->
   <suppress files="LFileModel.java"
             checks="ClassDataAbstractionCoupling"/>
+  <!-- Seems unavoidable. -->
+  <suppress files="LFileModel.java"
+            checks="MethodCount"/>
+
 </suppressions>

com.io7m.laurel.filemodel/pom.xml

@@ -49,6 +49,23 @@
       <groupId>com.io7m.darco</groupId>
       <artifactId>com.io7m.darco.api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.io7m.mime2045</groupId>
+      <artifactId>com.io7m.mime2045.core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.io7m.mime2045</groupId>
+      <artifactId>com.io7m.mime2045.parser.api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.io7m.mime2045</groupId>
+      <artifactId>com.io7m.mime2045.parser</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.io7m.mime2045</groupId>
+      <artifactId>com.io7m.mime2045.fileext</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.jooq</groupId>
       <artifactId>jooq</artifactId>

com.io7m.laurel.filemodel/src/main/java/com/io7m/laurel/filemodel/LExportRequest.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright © 2024 Mark Raynsford <[email protected]> https://www.io7m.com
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+ * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+
+package com.io7m.laurel.filemodel;
+
+import java.nio.file.Path;
+import java.util.Objects;
+
+/**
+ * A request to export a dataset.
+ *
+ * @param outputDirectory The output directory
+ * @param exportImages    {@code true} if images should be exported
+ */
+
+public record LExportRequest(
+  Path outputDirectory,
+  boolean exportImages)
+{
+  /**
+   * A request to export a dataset.
+   *
+   * @param outputDirectory The output directory
+   * @param exportImages    {@code true} if images should be exported
+   */
+
+  public LExportRequest
+  {
+    Objects.requireNonNull(outputDirectory, "outputDirectory");
+  }
+}

com.io7m.laurel.filemodel/src/main/java/com/io7m/laurel/filemodel/LFileModelType.java

@@ -532,4 +532,26 @@ CompletableFuture<?> captionsPaste(
    */
 
   AttributeReadableType<List<LValidationProblemType>> validationProblems();
+
+  /**
+   * Execute an export.
+   *
+   * @param request The export request
+   *
+   * @return The operation in progress
+   */
+
+  CompletableFuture<?> export(LExportRequest request);
+
+  /**
+   * @return The export events
+   */
+
+  AttributeReadableType<List<LFileModelEventType>> exportEvents();
+
+  /**
+   * Clear the export events.
+   */
+
+  void exportClear();
 }

com.io7m.laurel.filemodel/src/main/java/com/io7m/laurel/filemodel/internal/LCaptionFiles.java

@@ -0,0 +1,125 @@
+/*
+ * Copyright © 2024 Mark Raynsford <[email protected]> https://www.io7m.com
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+ * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+
+package com.io7m.laurel.filemodel.internal;
+
+import com.io7m.laurel.model.LCaption;
+import com.io7m.laurel.model.LCaptionName;
+import com.io7m.laurel.model.LGlobalCaption;
+
+import java.nio.file.Files;
+import java.nio.file.OpenOption;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+/**
+ * Functions to parse and serialize caption files.
+ */
+
+public final class LCaptionFiles
+{
+  private static final OpenOption[] OPEN_OPTIONS = {
+    StandardOpenOption.CREATE,
+    StandardOpenOption.WRITE,
+    StandardOpenOption.TRUNCATE_EXISTING,
+  };
+
+  private LCaptionFiles()
+  {
+
+  }
+
+  /**
+   * Parse a caption file.
+   *
+   * @param attributes The error attributes
+   * @param file       The file
+   *
+   * @return The parsed caption names
+   *
+   * @throws Exception On errors
+   */
+
+  public static List<LCaptionName> parse(
+    final Map<String, Object> attributes,
+    final Path file)
+    throws Exception
+  {
+    attributes.put("File", file);
+    return parseCaptions(attributes, Files.readString(file));
+  }
+
+  private static List<LCaptionName> parseCaptions(
+    final Map<String, Object> attributes,
+    final String rawText)
+  {
+    final var results =
+      new ArrayList<LCaptionName>();
+
+    final var segments =
+      List.of(rawText.split(","));
+
+    for (final var text : segments) {
+      final var trimmed = text.trim();
+      if (trimmed.isBlank()) {
+        continue;
+      }
+      attributes.put("Caption", trimmed);
+      results.add(new LCaptionName(trimmed));
+    }
+
+    return List.copyOf(results);
+  }
+
+  /**
+   * Serialize captions.
+   *
+   * @param attributes     The error attributes
+   * @param globalCaptions The global captions
+   * @param captions       The captions
+   * @param outputFile     The output file
+   *
+   * @throws Exception On errors
+   */
+
+  public static void serialize(
+    final Map<String, Object> attributes,
+    final List<LGlobalCaption> globalCaptions,
+    final List<LCaption> captions,
+    final Path outputFile)
+    throws Exception
+  {
+    attributes.put("File", outputFile);
+
+    final var rawLines =
+      new ArrayList<String>(globalCaptions.size() + captions.size());
+    globalCaptions.forEach(x -> rawLines.add(x.caption().name().text()));
+    captions.forEach(x -> rawLines.add(x.name().text()));
+
+    Files.writeString(
+      outputFile,
+      String.join(",\n", rawLines),
+      UTF_8,
+      OPEN_OPTIONS
+    );
+  }
+}