Add default property order for xml dataformat

Author: Daespen

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/XmlDataformatAnnotationIntrospector.java

@@ -16,12 +16,13 @@
 package io.adminshell.aas.v3.dataformat.xml;
 
 import com.fasterxml.jackson.databind.introspect.Annotated;
+import com.fasterxml.jackson.databind.introspect.AnnotatedClass;
 import com.fasterxml.jackson.dataformat.xml.JacksonXmlAnnotationIntrospector;
 
 /**
  * This class helps to dynamically decide how to de-/serialize classes and
  * properties defined in the AAS model library. It will automatically add a default namespace
- * to property names.
+ * to property names and set a default property order for contained elements.
  */
 public class XmlDataformatAnnotationIntrospector extends JacksonXmlAnnotationIntrospector {
     private static final long serialVersionUID = 1L;
@@ -42,4 +43,18 @@ public String findNamespace(Annotated ann) {
             return ns;
         }
     }
+
+    @Override
+    public String[] findSerializationPropertyOrder(AnnotatedClass ac) {
+        String[] order = super.findSerializationPropertyOrder(ac);
+        if (order == null) {
+            order = new String[] {
+                "extensions", "idShort", "displayNames", "category", "descriptions", "administration", "identification", "kind", "semanticId",
+                "qualifiers", "embeddedDataSpecification", "dataSpecifications", "isCaseOf", "security", "derivedFrom", "submodels", "assetInformation", "views", "externalSubjectId", "key", "allowDuplicates", "ordered", "valueId", "value",
+                "max", "min", "type", "valueType", "mimeType", "first", "second", "annotations", "revision", "version", "defaultThumbnail", "globalAssetId", "externalAssetId", "entityType", "statements", "assetKind", "billOfMaterials",
+                "specificAssetIds", "observed", "inoutputVariables", "inputVariables", "outputVariables", "submodelElements", "containedElements"
+            };
+        }
+        return order;
+    }
 }

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AdministrativeInformationMixin.java

@@ -18,11 +18,9 @@
 import java.util.List;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 
 import io.adminshell.aas.v3.model.Reference;
 
-@JsonPropertyOrder({"revision", "version"})
 public interface AdministrativeInformationMixin {
     @JsonIgnore
     public List<Reference> getDataSpecifications();

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AnnotatedRelationshipElementMixin.java

@@ -17,16 +17,13 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
 import io.adminshell.aas.v3.dataformat.xml.deserialization.DataElementsDeserializer;
 import io.adminshell.aas.v3.dataformat.xml.serialization.DataElementsSerializer;
 import io.adminshell.aas.v3.model.DataElement;
 
-@JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "kind", "semanticId",
-    "qualifiers", "dataSpecifications", "first", "second", "annotations"})
 public interface AnnotatedRelationshipElementMixin {
     @JsonSerialize(using = DataElementsSerializer.class)
     @JsonDeserialize(using = DataElementsDeserializer.class)

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AssetAdministrationShellMixin.java

@@ -17,16 +17,13 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
 import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 import io.adminshell.aas.v3.model.Reference;
 import io.adminshell.aas.v3.model.View;
 
-@JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "administration",
-    "identification", "dataSpecifications", "security", "derivedFrom", "submodels", "assetInformation", "views"})
 public interface AssetAdministrationShellMixin {
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "submodelRef")
     @JacksonXmlElementWrapper(namespace = AasXmlNamespaceContext.AAS_URI, localName = "submodelRefs")

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AssetInformationMixin.java

@@ -17,7 +17,6 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
@@ -26,9 +25,7 @@
 import io.adminshell.aas.v3.model.IdentifierKeyValuePair;
 import io.adminshell.aas.v3.model.Reference;
 
-@JsonPropertyOrder({"defaultThumbnail", "globalAssetId", "assetKind", "billOfMaterials", "specificAssetIds"})
 public interface AssetInformationMixin {
-
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "specificAssetId")
     @JacksonXmlElementWrapper(namespace = AasXmlNamespaceContext.AAS_URI, localName = "specificAssetIds")
     public List<IdentifierKeyValuePair> getSpecificAssetIds();

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AssetMixin.java

@@ -17,16 +17,13 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
 import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 import io.adminshell.aas.v3.dataformat.xml.deserialization.ReferencesDeserializer;
 import io.adminshell.aas.v3.model.Reference;
 
-@JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "administration",
-    "identification", "embeddedDataSpecifications", "isCaseOf"})
 public interface ConceptDescriptionMixin {
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "isCaseOf")
     @JsonDeserialize(using = ReferencesDeserializer.class)