Update/open notice with attributes

README.md

@@ -181,3 +181,5 @@ You will encounter these terms in the code and code comments:
 * **Visual Model**: Representation of the form used to fill in a notice, found in the `notice-types` folder of SDK
 * **Conceptual Model**: An intermediate representation made of fields and nodes, based on the SDK `fields.json`
 * **Physical Model**: The representation of a notice in XML, see "XML Generation"
+* **UI**: User Interface, in the editor demo this means the forms, buttons, links in the browser
+* **metadata**: In the editor demo this is generally SDK data

src/main/java/eu/europa/ted/eforms/noticeeditor/EformsNoticeEditorApp.java

@@ -32,12 +32,15 @@ public class EformsNoticeEditorApp implements CommandLineRunner {
   @Value("${eforms.sdk.versions}")
   private List<String> supportedSdks;
 
+  @Value("${eforms.sdk.autodownload}")
+  private boolean autoDownload;
+
   public static void main(final String[] args) {
     logger.info("STARTING eForms Notice Editor Demo Application");
     // See README.md on how to run server.
     // https://spring.io/guides/gs/serving-web-content/
 
-    // Here you have access to command line args.
+    // Here you have access to command line arguments.
     // logger.debug("args={}", Arrays.toString(args));
 
     SpringApplication.run(EformsNoticeEditorApp.class, args);
@@ -48,6 +51,19 @@ public void run(String... args) throws Exception {
     Validate.notEmpty(eformsSdkDir, "Undefined eForms SDK path");
     Validate.notNull(supportedSdks, "Undefined supported SDK versions");
 
+    logger.info("SDK autoDownload: {}", autoDownload);
+    if (autoDownload) {
+      // This automatically downloads the supported officially SDKs.
+      // You can test any SDK (even release candidates) by doing a git clone and putting the SDK
+      // files manually inside the folder where it would normally be downloaded.
+      autoDownloadSupportedSdks();
+    } else {
+      logger.info(
+          "Not automatically downloading SDKs, put files manually or set autoDownload to true in application.yaml");
+    }
+  }
+
+  private void autoDownloadSupportedSdks() {
     for (final String sdkVersion : supportedSdks) {
       try {
         SdkDownloader.downloadSdk(new SdkVersion(sdkVersion), Path.of(eformsSdkDir));

src/main/java/eu/europa/ted/eforms/noticeeditor/controller/XmlRestController.java

@@ -3,6 +3,7 @@
 import java.util.Optional;
 import javax.servlet.http.HttpServletResponse;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.scheduling.annotation.AsyncConfigurer;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -21,17 +22,32 @@ public class XmlRestController implements AsyncConfigurer {
   @Autowired
   private XmlWriteService xmlService;
 
+  /**
+   * Enriches the XML for human readability but it becomes invalid. Also adds .dot files and other
+   * debug files in target.
+   */
+  @Value("${xml.generation.debug}")
+  private boolean debug;
+
+  @Value("${xml.generation.skipIfEmpty}")
+  private boolean skipIfNoValue;
+
+  @Value("${xml.generation.sortXmlElements}")
+  private boolean sortXmlElements;
+
   /**
    * Save: Takes notice as JSON and builds notice XML. The SDK version is in the notice metadata.
    */
   @RequestMapping(value = "/notice/save/validation/none", method = RequestMethod.POST,
       produces = SdkService.MIME_TYPE_XML, consumes = SdkService.MIME_TYPE_JSON)
-  public void saveNotice(final HttpServletResponse response, final @RequestBody String noticeJson)
+  public void saveNotice(final HttpServletResponse response,
+      final @RequestBody String noticeJson)
       throws Exception {
-    // Enriches the XML for human readability but it becomes invalid.
-    // Also adds .dot files in target.
-    final boolean debug = false;
-    xmlService.saveNoticeAsXml(Optional.of(response), noticeJson, debug);
+    // For the XML generation config booleans, see application.yaml
+    xmlService.saveNoticeAsXml(Optional.of(response), noticeJson,
+        debug,
+        skipIfNoValue,
+        sortXmlElements);
   }
 
   /**
@@ -42,7 +58,6 @@ public void saveNotice(final HttpServletResponse response, final @RequestBody St
       produces = SdkService.MIME_TYPE_XML, consumes = SdkService.MIME_TYPE_JSON)
   public void saveNoticeAndXsdValidate(final HttpServletResponse response,
       final @RequestBody String noticeJson) throws Exception {
-    final boolean debug = false;
     xmlService.validateUsingXsd(Optional.of(response), noticeJson, debug);
   }
 
@@ -55,7 +70,6 @@ public void saveNoticeAndXsdValidate(final HttpServletResponse response,
       produces = SdkService.MIME_TYPE_XML, consumes = SdkService.MIME_TYPE_JSON)
   public void saveNoticeAndCvsValidate(final HttpServletResponse response,
       final @RequestBody String noticeJson) throws Exception {
-    final boolean debug = false;
     xmlService.validateUsingCvs(Optional.of(response), noticeJson, debug);
   }
 }

src/main/java/eu/europa/ted/eforms/noticeeditor/helper/notice/ConceptTreeField.java

@@ -1,9 +1,13 @@
 package eu.europa.ted.eforms.noticeeditor.helper.notice;
 
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
 /**
- * Conceptual field. Leaf in the conceptual tree. This holds non-metadata field information and the
- * field id. This is not an SDK field, this only points to an SDK field to reference metadata.
+ * Conceptual field. Leaf in the conceptual tree. This holds non-metadata field information like the
+ * value and the associated SDK field id. This is not an SDK field, this only points to an SDK field
+ * to reference the metadata. A field item cannot have child items!
  */
+@JsonPropertyOrder({"idUnique", "counter", "fieldId", "value"})
 public class ConceptTreeField extends ConceptTreeItem {
   private final String value;
 
@@ -14,7 +18,9 @@ public ConceptTreeField(final String idUnique, final String idInSdkFieldsJson, f
   }
 
   /**
-   * For convenience and to make it clear that the ID in the SDK is the field ID in this case.
+   * For convenience and to make it clear that the ID in the SDK is the field ID in this case. It
+   * can be used to get general information about the field (data from fields.json). This does not
+   * include the counter.
    */
   public String getFieldId() {
     return idInSdkFieldsJson;

src/main/java/eu/europa/ted/eforms/noticeeditor/helper/notice/ConceptTreeItem.java

@@ -2,19 +2,20 @@
 
 import java.util.Objects;
 import org.apache.commons.lang3.Validate;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 
 /**
- * Abstract item holding common information. References SDK metadata.
+ * Abstract item holding common conceptual information for a notice. References SDK metadata.
  */
 public abstract class ConceptTreeItem {
   /**
-   * Unique identifier among children at same level.
+   * Unique identifier among children at same level. Counter excluded.
    */
   private final String idUnique;
 
   /**
    * This id is not unique as some concept items can be repeatead while still have the same metadata
-   * (pointing to same field or same node multiple times).
+   * (pointing to same field or same node multiple times). A counter helps to differentiate them.
    */
   protected final String idInSdkFieldsJson;
 
@@ -32,12 +33,17 @@ protected ConceptTreeItem(final String idUnique, final String idInSdkFieldsJson,
   }
 
   /**
-   * @return Unique identifier among children at same level.
+   * @return Unique identifier among children at same level. Counter excluded.
    */
   public String getIdUnique() {
     return idUnique;
   }
 
+  @JsonIgnore // This will be covered by getFieldId and getNodeId
+  public String getIdInSdkFieldsJson() {
+    return idInSdkFieldsJson;
+  }
+
   public int getCounter() {
     return counter;
   }
@@ -50,6 +56,7 @@ public String toString() {
 
   @Override
   public int hashCode() {
+    // Important: the counter is taken into account, this matters for repeatable items.
     return Objects.hash(counter, idInSdkFieldsJson, idUnique);
   }
 
@@ -65,6 +72,7 @@ public boolean equals(Object obj) {
       return false;
     }
     ConceptTreeItem other = (ConceptTreeItem) obj;
+    // Important: the counter is taken into account, this matters for repeatable items.
     return counter == other.counter && Objects.equals(idInSdkFieldsJson, other.idInSdkFieldsJson)
         && Objects.equals(idUnique, other.idUnique);
   }