working on deserialization, added functionality

   * submodels are collected and added to AAS
   * LangString, ReferenceElement, RelationshipElement are properly handled
   * refactoring utility methods to handle custom subtypes (e.g. when cloning or creating new references)
   * updated MappingProvider to also accept classes with remaining generic type

Author: mjacoby

dataformat-aml/pom.xml

@@ -33,6 +33,11 @@
             <artifactId>jaxb-api</artifactId>
             <version>${jaxb.version}</version>
         </dependency>
+        <dependency>
+            <groupId>xerces</groupId>
+            <artifactId>xercesImpl</artifactId>
+            <version>2.12.1</version>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.persistence</groupId>
             <artifactId>org.eclipse.persistence.moxy</artifactId>

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

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.adminshell.aas.v3.dataformat.aml.common;
+
+import io.adminshell.aas.v3.dataformat.aml.serialization.naming.NamingStrategy;
+import io.adminshell.aas.v3.dataformat.mapping.Mapper;
+import io.adminshell.aas.v3.dataformat.mapping.MappingContext;
+import io.adminshell.aas.v3.dataformat.mapping.MappingProvider;
+import java.beans.PropertyDescriptor;
+
+/**
+ * Abstract base class for MappingContext used for mapping between AML and AAS
+ *
+ * @param <T>
+ */
+public class AbstractMappingContext<T extends Mapper> extends MappingContext<T> {
+
+    protected final NamingStrategy classNamingStrategy;
+    protected final NamingStrategy propertyNamingStrategy;
+    protected final PropertyDescriptor property;
+
+    protected AbstractMappingContext(MappingProvider<T> mappingProvider,
+            NamingStrategy classNamingStrategy,
+            NamingStrategy propertyNamingStrategy,
+            PropertyDescriptor property) {
+        super(mappingProvider);
+        this.classNamingStrategy = classNamingStrategy;
+        this.propertyNamingStrategy = propertyNamingStrategy;
+        this.property = property;
+    }
+
+    /**
+     * Gets the class naming strategy. This is used to resolve naming
+     * differences in class names between AML and AAS.
+     *
+     * @return the naming strategy
+     */
+    public NamingStrategy getClassNamingStrategy() {
+        return classNamingStrategy;
+    }
+
+    /**
+     * Gets the property naming strategy. This is used to resolve naming
+     * differences in property namings between AML and AAS.
+     *
+     * @return
+     */
+    public NamingStrategy getPropertyNamingStrategy() {
+        return propertyNamingStrategy;
+    }
+
+    /**
+     * Gets the currently processed property if present, otherwise null
+     *
+     * @return the currently processed property if present, otherwise null
+     */
+    public PropertyDescriptor getProperty() {
+        return property;
+    }
+
+}

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

@@ -50,7 +50,7 @@ public <T> void useImplementation(Class<T> aasInterface, Class<? extends T> impl
      * Creates a new instance for a given aasInterface. If the
      *
      * @param <T> type to create
-     * @param aasInterface class to find instantiate
+     * @param aasInterfaceType class to find instantiate
      * @return an instance of aasInterface
      * @throws NoSuchMethodException
      * @throws InstantiationException
@@ -59,19 +59,34 @@ public <T> void useImplementation(Class<T> aasInterface, Class<? extends T> impl
      * concrete type to instantiate could be found
      * @throws InvocationTargetException
      */
-    public <T> T newInstance(Class<T> aasInterface) throws NoSuchMethodException, InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
-        if (aasInterface == null) {
+    public <T> T newInstance(Class<T> aasInterfaceType) throws NoSuchMethodException, InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
+        Constructor<?> constructor = getImplementationType(aasInterfaceType).getConstructor();
+        constructor.setAccessible(true);
+        return (T) constructor.newInstance();
+    }
+
+    /**
+     * Gets the concrete implementation type to use for a given type. If there
+     * is no explicit type mapping and the provided type is concrete, the type
+     * itself is returned.
+     *
+     * @param <T> type information
+     * @param aasInterfaceType the type to find a concrete implementation type
+     * for
+     * @throws IllegalArgumentException if there is no type mapping for the
+     * provided type and the type is not concrete
+     * @return a concrete implementation type for the given type
+     */
+    public <T> Class<? extends T> getImplementationType(Class<T> aasInterfaceType) {
+        if (aasInterfaceType == null) {
             throw new IllegalArgumentException("aasInterface must be non-null");
         }
-        Class<?> classToInstantiate = aasInterface;
-        if (typeMapping.containsKey(aasInterface)) {
-            classToInstantiate = typeMapping.get(aasInterface);
+        if (typeMapping.containsKey(aasInterfaceType)) {
+            return (Class<? extends T>) typeMapping.get(aasInterfaceType);
         }
-        if (classToInstantiate.isInterface()) {
-            throw new IllegalArgumentException("could not resolve type for interface " + classToInstantiate.getName());
+        if (aasInterfaceType.isInterface()) {
+            throw new IllegalArgumentException("could not resolve type for interface " + aasInterfaceType.getName());
         }
-        Constructor<?> constructor = classToInstantiate.getConstructor();
-        constructor.setAccessible(true);
-        return (T) constructor.newInstance();
+        return aasInterfaceType;
     }
 }

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

@@ -18,10 +18,24 @@
 import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.AssetAdministrationShellEnvironmentMapper;
 import io.adminshell.aas.v3.dataformat.aml.AmlDeserializationConfig;
 import io.adminshell.aas.v3.dataformat.aml.AmlDocumentInfo;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.AssetAdministrationShellMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.EnumMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.IdentifiableMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.LangStringCollectionMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.ReferableMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.ReferenceElementMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.ReferenceMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.mappers.RelationshipElementMapper;
 import io.adminshell.aas.v3.dataformat.aml.model.caex.CAEXFile;
+import io.adminshell.aas.v3.dataformat.aml.serialization.naming.AbstractClassNamingStrategy;
+import io.adminshell.aas.v3.dataformat.aml.serialization.naming.NumberingClassNamingStrategy;
+import io.adminshell.aas.v3.dataformat.aml.serialization.naming.PropertyNamingStrategy;
 import io.adminshell.aas.v3.dataformat.mapping.MappingException;
 import io.adminshell.aas.v3.dataformat.mapping.MappingProvider;
 import io.adminshell.aas.v3.model.AssetAdministrationShellEnvironment;
+import io.adminshell.aas.v3.model.Identifiable;
+import io.adminshell.aas.v3.model.MultiLanguageProperty;
+import io.adminshell.aas.v3.model.Referable;
 import java.util.List;
 
 /**
@@ -49,9 +63,24 @@ public AssetAdministrationShellEnvironment map(CAEXFile aml) throws MappingExcep
         AmlParser parser = new AmlParser(aml);
         MappingProvider mappingProvider = new MappingProvider(Mapper.class, new DefaultMapper(), new DefaultMapper());
         mappingProvider.register(new AssetAdministrationShellEnvironmentMapper());
-        MappingContext context = new MappingContext(mappingProvider, config.getTypeFactory());
+        mappingProvider.register(new EnumMapper());
+        mappingProvider.register(new ReferenceMapper());
+        mappingProvider.register(new AssetAdministrationShellMapper());
+        mappingProvider.register(new LangStringCollectionMapper());
+        mappingProvider.register(new RelationshipElementMapper());
+        mappingProvider.register(new ReferenceElementMapper());
+        mappingProvider.register(new ReferableMapper<Referable>());
+        mappingProvider.register(new IdentifiableMapper<Identifiable>());
+        AbstractClassNamingStrategy classNamingStrategy = new NumberingClassNamingStrategy();
+
+        PropertyNamingStrategy propertyNamingStrategy = new PropertyNamingStrategy();
+        propertyNamingStrategy.registerCustomNaming(Referable.class, "descriptions", "description", true);
+        propertyNamingStrategy.registerCustomNaming(MultiLanguageProperty.class, "values", "value", true);
+//        propertyNamingStrategy.registerCustomNaming(Qualifier.class, x -> "qualifier:" + x.getType() + "=" + x.getValue(), false);
+        MappingContext context = new MappingContext(mappingProvider, classNamingStrategy, propertyNamingStrategy, config.getTypeFactory());
         context.setDocumentInfo(AmlDocumentInfo.fromFile(aml));
-        Object result = context.getMappingProvider().getMapper(AssetAdministrationShellEnvironment.class).map(parser, context);
+        AssetAdministrationShellEnvironment result = (AssetAdministrationShellEnvironment) context.getMappingProvider().getMapper(AssetAdministrationShellEnvironment.class).map(parser, context);
+        parser.resolveIdsToReferences(result);
         return (AssetAdministrationShellEnvironment) result;
     }
 }

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

@@ -17,17 +17,30 @@
 
 import io.adminshell.aas.v3.dataformat.aml.model.caex.CAEXFile;
 import io.adminshell.aas.v3.dataformat.aml.model.caex.CAEXObject;
+import io.adminshell.aas.v3.dataformat.core.util.AasUtils;
+import io.adminshell.aas.v3.dataformat.mapping.MappingException;
+import io.adminshell.aas.v3.model.AssetAdministrationShellEnvironment;
+import io.adminshell.aas.v3.model.Reference;
+import java.beans.PropertyDescriptor;
+import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 
 /**
  * Wraps an AML file and provides a pointer to the current position within that
  * file
  *
- * @author jab
  */
 public class AmlParser {
 
     private final CAEXFile content;
     private CAEXObject current;
+    private final Map<String, Reference> idToReference = new HashMap<>();
+    private final Map<ObjectLocationByProperty, List<String>> idsToResolve = new HashMap<>();
 
     public AmlParser(CAEXFile content) {
         this.content = content;
@@ -61,4 +74,107 @@ public void setCurrent(CAEXObject current) {
         this.current = current;
     }
 
+    /**
+     * Saves mapping between AML-based ID and a AAS Reference that is needed
+     * later on to resolve internalLinks within the AML document. This should
+     * always be called when creating/reading a Referable from AML.
+     *
+     * @param amlId AML-based ID of the element/Referable
+     * @param reference AAS reference to the Referable
+     */
+    public void collectIdMapping(String amlId, Reference reference) {
+        idToReference.put(amlId, reference);
+    }
+
+    /**
+     * Marks a property to contain an AAS Reference which at time of mapping may
+     * not yet be available.
+     *
+     * @param parent parent AAS object that contains the property
+     * @param property property that should contain the resolved reference(s)
+     * later. Its type must be either Reference or collection of Reference
+     * @param id AML-based ID of the targeted Referabe that should later be
+     * resolved to a Reference
+     */
+    public void resolveIdToReferenceLater(Object parent, PropertyDescriptor property, String id) {
+        ObjectLocationByProperty location = new ObjectLocationByProperty(parent, property);
+        if (!idsToResolve.containsKey(location)) {
+            idsToResolve.put(location, new ArrayList<>());
+        }
+        idsToResolve.get(location).add(id);
+    }
+
+    /**
+     * Resolves properties containing References expressed through AML-based IDs
+     * which have been previously makred by calling
+     * resolveIdToReferenceLater(..)
+     *
+     * @param environment the environment to apply this resolution to
+     * @throws MappingException when resolving fails, e.g. because cardinalities
+     * do not match or AML IDs cannot be resolved
+     */
+    public void resolveIdsToReferences(AssetAdministrationShellEnvironment environment) throws MappingException {
+        for (Map.Entry<ObjectLocationByProperty, List<String>> entry : idsToResolve.entrySet()) {
+            Object value = null;
+            Class<?> acceptedType = null;
+            List<String> idsToResolve = entry.getValue().stream().filter(x -> x != null).collect(Collectors.toList());
+            if (!idsToResolve.isEmpty()) {
+                if (Collection.class.isAssignableFrom(entry.getKey().property.getReadMethod().getReturnType())) {
+                    acceptedType = AasUtils.getCollectionContentType(entry.getKey().property.getReadMethod().getGenericReturnType());
+                    Collection<Reference> collection = new ArrayList<>();
+                    for (String id : idsToResolve) {
+                        if (!idToReference.containsKey(id)) {
+                            throw new MappingException(String.format("error adding resolved references for property %s - "
+                                    + "found unresolved AML id %s",
+                                    entry.getKey().property.getName(),
+                                    id));
+                        }
+                        collection.add(idToReference.get(id));
+                    }
+                    value = collection;
+                } else {
+                    acceptedType = entry.getKey().property.getReadMethod().getReturnType();
+                    if (idsToResolve.size() > 1) {
+                        throw new MappingException(String.format("error adding resolved references for property %s - found %d ids but expected zero or one",
+                                entry.getKey().property.getName(),
+                                idsToResolve.size()));
+                    }
+                    if (!idToReference.containsKey(idsToResolve.get(0))) {
+                        throw new MappingException(String.format("error adding resolved references for property %s - "
+                                + "found unresolved AML id %s",
+                                entry.getKey().property.getName(),
+                                idsToResolve.get(0)));
+                    }
+                    value = idToReference.get(idsToResolve.get(0));
+                }
+            }
+            if (value != null) {
+                if (!Reference.class.isAssignableFrom(acceptedType)) {
+                    throw new MappingException(String.format("error adding resolved references for property %s - expected type Reference or Collection<Reference> but found %s",
+                            entry.getKey().property.getName(),
+                            acceptedType));
+                }
+            }
+            try {
+                entry.getKey().property.getWriteMethod().invoke(entry.getKey().parent, value);
+            } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException ex) {
+                throw new MappingException("error resolving references", ex);
+            }
+        }
+    }
+
+    private class ObjectLocationByProperty {
+
+        Object parent;
+        PropertyDescriptor property;
+
+        private ObjectLocationByProperty(Object parent, PropertyDescriptor property) {
+            this.parent = parent;
+            this.property = property;
+        }
+    }
+
+    public Map<String, Reference> getIdToReference() {
+        return idToReference;
+    }
 }