-refactoring

- added unit test to AML serializer

Author: mjacoby

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/AmlDeserializationConfig.java

@@ -18,6 +18,7 @@
 import io.adminshell.aas.v3.dataformat.aml.deserialization.AasTypeFactory;
 
 public class AmlDeserializationConfig {
+
     public static Builder builder() {
         return new Builder();
     }
@@ -27,6 +28,7 @@ public static Builder builder() {
     private AmlDeserializationConfig(AasTypeFactory typeFactory) {
         this.typeFactory = typeFactory;
     }
+
     public AasTypeFactory getTypeFactory() {
         return typeFactory;
     }

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/deserialization/Aml2AasMapper.java

@@ -36,7 +36,9 @@ public Aml2AasMapper(AmlDeserializationConfig config) {
     }
 
     /**
-     * Maps an AML file (represented by a CAEXFile) to an AssetAdministrationShellEnvironment
+     * Maps an AML file (represented by a CAEXFile) to an
+     * AssetAdministrationShellEnvironment
+     *
      * @param aml the AML source file to map
      * @return AssetAdministrationShellEnvironment representation
      * @throws MappingException if the mapping fails

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/deserialization/AmlParser.java

@@ -53,7 +53,7 @@ public CAEXObject getCurrent() {
     }
 
     /**
-     * Sets the CAEXObject that currently is being processed. 
+     * Sets the CAEXObject that currently is being processed.
      *
      * @param current the object currently being processed
      */

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/deserialization/Mapper.java

@@ -16,8 +16,10 @@
 package io.adminshell.aas.v3.dataformat.aml.deserialization;
 
 import io.adminshell.aas.v3.dataformat.mapping.TargetBasedMapper;
+
 /**
  * Utility interface for all AML to AAS mappers
+ *
  * @param <T> type to be deserialized
  */
 public interface Mapper<T> extends TargetBasedMapper<T, AmlParser, MappingContext> {

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/serialization/AasToAmlMapper.java

@@ -56,7 +56,9 @@ public class AasToAmlMapper {
     private static final org.slf4j.Logger log = LoggerFactory.getLogger(AasToAmlMapper.class);
 
     /**
-     * Maps an AssetAdministrationShellEnvironment to an AML file (represented by a CAEXFile)
+     * Maps an AssetAdministrationShellEnvironment to an AML file (represented
+     * by a CAEXFile)
+     *
      * @param env the AssetAdministrationShellEnvironment to map
      * @param config the serialization conig
      * @return an AML representation of the AssetAdministrationShellEnvironment

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/serialization/AmlGenerator.java

@@ -36,11 +36,20 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Immutable class supporting creation of AML file by encalsulating different
+ * common tasks and functionality, e.g. id generation and caching. To create new
+ * instances with modified properties use provided with...(...) functions.
+ */
 public class AmlGenerator {
 
     private static final Logger log = LoggerFactory.getLogger(AmlGenerator.class);
     public static final String REFERABLE_REFERENCE_INTERFACE_CLASS = "ReferableReference";
     private static final String DEFAULT_REF_SEMANTIC_PREFIX = "AAS";
+
+    public static Builder builder() {
+        return new Builder();
+    }
     private final String refSemanticPrefix;
     private final CAEXObject.Builder current;
     private final AmlDocumentInfo documentInfo;
@@ -66,6 +75,12 @@ private AmlGenerator(
         this.reference = reference;
     }
 
+    /**
+     * Creates a new instance with new current CAEXObject.Builder
+     *
+     * @param current new current CAEXObject.Builder
+     * @return new immutable instance with CAEXObject.Builder
+     */
     public AmlGenerator with(CAEXObject.Builder current) {
         return new AmlGenerator(documentInfo,
                 idGenerator,
@@ -76,6 +91,12 @@ public AmlGenerator with(CAEXObject.Builder current) {
                 reference);
     }
 
+    /**
+     * Creates a new instance with reference to new parent object in AAS
+     *
+     * @param parent reference to new parent element
+     * @return new immutable instance with new parent
+     */
     public AmlGenerator with(Referable parent) {
         return new AmlGenerator(
                 documentInfo,
@@ -87,6 +108,12 @@ public AmlGenerator with(Referable parent) {
                 AasUtils.toReference(reference, parent));
     }
 
+    /**
+     * Creates a new instance with given prefix for refSemantic tags
+     *
+     * @param value new prefix for refSemantic tags
+     * @return new immutable instance given refSemantic prefix
+     */
     public AmlGenerator withRefSemanticPrefix(String value) {
         return new AmlGenerator(
                 documentInfo,
@@ -98,62 +125,36 @@ public AmlGenerator withRefSemanticPrefix(String value) {
                 reference);
     }
 
+    /**
+     * Adds additional information to the AML file
+     *
+     * @param additionalInformation additional information to add
+     */
     public void addAdditionalInformation(List<Object> additionalInformation) {
         fileBuilder.addAdditionalInformation(additionalInformation);
     }
 
-    public static Builder builder() {
-        return new Builder();
-    }
-
-    public static class Builder {
-
-        private String refSemanticPrefix = DEFAULT_REF_SEMANTIC_PREFIX;
-        private CAEXObject.Builder current;
-        private CAEXFile.Builder fileBuilder = CAEXFile.builder();
-        private AmlDocumentInfo documentInfo = new AmlDocumentInfo();
-        private IdGenerator idGenerator = new UuidGenerator();
-
-        public AmlGenerator build() {
-            return new AmlGenerator(documentInfo,
-                    idGenerator,
-                    new HashMap<>(),
-                    refSemanticPrefix,
-                    fileBuilder,
-                    current,
-                    new DefaultReference.Builder().build());
-        }
-
-        public Builder refSemanticPrefix(String value) {
-            this.refSemanticPrefix = value;
-            return this;
-        }
-
-        public Builder current(CAEXObject.Builder value) {
-            this.current = value;
-            return this;
-        }
-
-        public Builder idGenerator(IdGenerator value) {
-            this.idGenerator = value;
-            return this;
-        }
-
-        public Builder file(CAEXFile.Builder value) {
-            this.fileBuilder = value;
-            return this;
-        }
-
-        public Builder documentInfo(AmlDocumentInfo value) {
-            this.documentInfo = value;
-            return this;
-        }
-    }
-
+    /**
+     * Generates a new ID without caching it.
+     *
+     * @return a new ID
+     */
     public String newId() {
         return idGenerator.next();
     }
 
+    /**
+     * Gets the ID for given object. If obj is an instance of Referable it is
+     * first converted to reference pointing to that element. In that case, or
+     * if the obj is already an instance of Reference, an already existing ID
+     * will be returned if available, otherwise a new one is created and cached.
+     * If obj is neither an instance of Reference nor Referable, a new ID is
+     * generated and not cached.
+     *
+     * @param obj object to generate an ID for
+     * @return an ID that might or might not be cached (depending of type of
+     * obj)
+     */
     public String getId(Object obj) {
         if (obj == null) {
             return idGenerator.next();
@@ -177,6 +178,11 @@ public String getId(Object obj) {
         return result;
     }
 
+    /**
+     * Adds an object to the current element of the AML document
+     *
+     * @param caexObject the object to add
+     */
     public void add(CAEXObject caexObject) {
         if (caexObject == null) {
             return;
@@ -190,6 +196,11 @@ public void add(CAEXObject caexObject) {
         }
     }
 
+    /**
+     * Adds an attribute to the current element of the AML document
+     *
+     * @param attribute the attribute to add
+     */
     public void addAttribute(AttributeType attribute) {
         if (attribute == null) {
             return;
@@ -221,14 +232,26 @@ private void addExternalInterface(RoleClassType.ExternalInterface externalInterf
         }
     }
 
-    public void addExternalInterfaceForReference(MappingContext context) {
+    /**
+     * Adds an external interface with name and roleCall ReferableReference to
+     * the current element of the AML document
+     */
+    public void addExternalInterfaceForReference() {
         addExternalInterface(RoleClassType.ExternalInterface.builder()
                 .withID(newId())
                 .withName(REFERABLE_REFERENCE_INTERFACE_CLASS)
                 .withRefBaseClassPath(documentInfo.getAssetAdministrationShellInterfaceClassLib() + "/" + REFERABLE_REFERENCE_INTERFACE_CLASS)
                 .build(), false);
     }
 
+    /**
+     * Adds an internal link with given namen pointing from source to target to
+     * the current element of the AML document
+     *
+     * @param name name if the link
+     * @param source source element of the link
+     * @param target reference pointing to the target element
+     */
     public void addInternalLink(String name, Referable source, Reference target) {
         if (InternalElementType.Builder.class.isAssignableFrom(current.getClass())) {
             InternalElementType.Builder builder = (InternalElementType.Builder) current;
@@ -243,7 +266,15 @@ public void addInternalLink(String name, Referable source, Reference target) {
         }
     }
 
-    public void addExternalInterfaceForUnresolvableReference(String name, Reference reference, MappingContext context) {
+    /**
+     * Adds an external interface of type ReferableReference with given name
+     * with unresolvabled reference as value to the current element of the AML
+     * document
+     *
+     * @param name name of the interface
+     * @param reference unresolvable target reference
+     */
+    public void addExternalInterfaceForUnresolvableReference(String name, Reference reference) {
         addExternalInterface(RoleClassType.ExternalInterface.builder()
                 .withID(idGenerator.next())
                 .withName(name)
@@ -258,6 +289,12 @@ public void addExternalInterfaceForUnresolvableReference(String name, Reference
                 false);
     }
 
+    /**
+     * Clears the ID cache. This should be used with caution as it may cause
+     * reference resolution mechanism to fail. Typically it will only be called
+     * after processing the InstanceHierarchy elements and before creating
+     * custom SystemUnitClasses
+     */
     public void clearIdCache() {
         idCache.clear();
     }
@@ -344,23 +381,66 @@ public AttributeType.RefSemantic refSemantic(Class<?> type, String propertyName)
                 .build();
     }
 
+    /**
+     * Creates a refSemantic object for a given property
+     *
+     * @param property the property
+     * @return the generated refSemantic object
+     */
     public AttributeType.RefSemantic refSemantic(PropertyDescriptor property) {
         return refSemantic(property.getReadMethod().getDeclaringClass(), property.getName());
     }
 
-    public String refBaseSystemUnitPath(Object value, MappingContext context) {
-        return documentInfo.getAssetAdministrationShellSystemUnitClassLib()
-                + "/" + context.getInternalElementNamingStrategy().getName(
-                        value.getClass(),
-                        value,
-                        null);
-    }
-
+    /**
+     * Gets to AML document info
+     *
+     * @return the AML document info
+     */
     public AmlDocumentInfo getDocumentInfo() {
         return documentInfo;
     }
 
-    public Reference getReference() {
-        return reference;
+    public static class Builder {
+
+        private String refSemanticPrefix = DEFAULT_REF_SEMANTIC_PREFIX;
+        private CAEXObject.Builder current;
+        private CAEXFile.Builder fileBuilder = CAEXFile.builder();
+        private AmlDocumentInfo documentInfo = new AmlDocumentInfo();
+        private IdGenerator idGenerator = new UuidGenerator();
+
+        public AmlGenerator build() {
+            return new AmlGenerator(documentInfo,
+                    idGenerator,
+                    new HashMap<>(),
+                    refSemanticPrefix,
+                    fileBuilder,
+                    current,
+                    new DefaultReference.Builder().build());
+        }
+
+        public Builder refSemanticPrefix(String value) {
+            this.refSemanticPrefix = value;
+            return this;
+        }
+
+        public Builder current(CAEXObject.Builder value) {
+            this.current = value;
+            return this;
+        }
+
+        public Builder idGenerator(IdGenerator value) {
+            this.idGenerator = value;
+            return this;
+        }
+
+        public Builder file(CAEXFile.Builder value) {
+            this.fileBuilder = value;
+            return this;
+        }
+
+        public Builder documentInfo(AmlDocumentInfo value) {
+            this.documentInfo = value;
+            return this;
+        }
     }
 }

dataformat-aml/src/main/java/io/adminshell/aas/v3/dataformat/aml/serialization/DefaultMapper.java

@@ -20,12 +20,15 @@
 import io.adminshell.aas.v3.dataformat.core.ReflectionHelper;
 import io.adminshell.aas.v3.dataformat.core.util.AasUtils;
 import io.adminshell.aas.v3.dataformat.mapping.MappingException;
+import io.adminshell.aas.v3.model.MultiLanguageProperty;
 import io.adminshell.aas.v3.model.Referable;
 import java.beans.PropertyDescriptor;
 import java.lang.reflect.InvocationTargetException;
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 public class DefaultMapper<T> implements Mapper<T> {
 
@@ -137,6 +140,7 @@ protected boolean skipProperty(PropertyDescriptor property) {
     }
 
     protected void mapProperties(T value, AmlGenerator generator, MappingContext context) throws MappingException {
+        List<String> collect = AasUtils.getAasProperties(value.getClass()).stream().map(x -> x.getName()).collect(Collectors.toList());
         for (PropertyDescriptor property : AasUtils.getAasProperties(value.getClass())) {
             if (!skipProperty(property)) {
                 context.with(property)