Merge pull request #60 from kenwenzel/custom-xml-factory

GH-59 Allow to use custom instances of XMLInputFactory and XMLOutputFactory

Author: FrankSchnicke

.github/workflows/docfx-build-publish.yml

@@ -0,0 +1,29 @@
+# This workflow will build and publish documentation with docfx
+# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
+
+name: Documentation Publish
+
+on:
+  push:
+    branches: 
+      - main
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    name: Build and publish documentation
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Build docfx
+      uses: nikeee/docfx-action@v1.0.0
+      with:
+        args: docs/docfx.json
+
+    - name: Publish
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_site
+        force_orphan: true

.github/workflows/maven-deploy-to-maven-central.yml

@@ -5,8 +5,8 @@
 name: Generate and Deploy to Sonatype
 
 on:
-  push:
-    branches: [ main ]
+  release:
+    types: [published]
 
 jobs:
 

README.md

@@ -16,6 +16,7 @@ root:
 
 `mvn clean package`
 
+
 or by integrating the respective modules as dependencies from Maven Central Repository, for instance:
 
 ```
@@ -68,4 +69,4 @@ We always look for contributions, bug reports, feature requests etc. Simply open
 | Jan Blume | Fraunhofer IOSB | []() |  |  |  |  |  |  |  |  | x |
 
 This project was initiated by SAP and Fraunhofer to provide a foundation for the
-AAS development and to foster its dissemination.
+AAS development and to foster its dissemination.

dataformat-aasx/src/main/java/io/adminshell/aas/v3/dataformat/aasx/AASXDeserializer.java

@@ -47,7 +47,7 @@ public class AASXDeserializer {
     private static final String XML_TYPE = "http://www.admin-shell.io/aasx/relationships/aas-spec";
     private static final String AASX_ORIGIN = "/aasx/aasx-origin";
 
-    private XmlDeserializer deserializer = new XmlDeserializer();
+    private final XmlDeserializer deserializer;
 
     private AssetAdministrationShellEnvironment environment;
     private final OPCPackage aasxRoot;
@@ -61,6 +61,7 @@ public class AASXDeserializer {
      */
     public AASXDeserializer(InputStream inputStream) throws InvalidFormatException, IOException {
         aasxRoot = OPCPackage.open(inputStream);
+        deserializer = new XmlDeserializer();
     }
 
     /**

dataformat-aasx/src/main/java/io/adminshell/aas/v3/dataformat/aasx/AASXSerializer.java

@@ -61,12 +61,13 @@ public class AASXSerializer {
 
     private static final String AASSUPPL_RELTYPE = "http://www.admin-shell.io/aasx/relationships/aas-suppl";
 
-    private Serializer xmlSerializer = new XmlSerializer();
+    private final Serializer xmlSerializer;
 
     /**
      * Default constructor
      */
     public AASXSerializer() {
+        xmlSerializer = new XmlSerializer();
     }
 
     /**

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

@@ -25,12 +25,12 @@
 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.AssetInformation;
 import io.adminshell.aas.v3.model.Identifiable;
 import io.adminshell.aas.v3.model.MultiLanguageProperty;
 import io.adminshell.aas.v3.model.Referable;
 import io.adminshell.aas.v3.model.Qualifiable;
 
-
 import java.util.List;
 
 /**
@@ -64,8 +64,8 @@ public AssetAdministrationShellEnvironment map(CAEXFile aml) throws MappingExcep
         mappingProvider.register(new LangStringCollectionMapper());
         mappingProvider.register(new RelationshipElementMapper());
         mappingProvider.register(new ReferenceElementMapper());
-        mappingProvider.register(new ReferableMapper<Referable>());
-        mappingProvider.register(new IdentifiableMapper<Identifiable>());
+        mappingProvider.register(new ReferableMapper<>());
+        mappingProvider.register(new IdentifiableMapper<>());
         mappingProvider.register(new ConstraintCollectionMapper());
         mappingProvider.register(new QualifierMapper());
         mappingProvider.register(new OperationCollectionMapper());
@@ -77,12 +77,15 @@ public AssetAdministrationShellEnvironment map(CAEXFile aml) throws MappingExcep
         mappingProvider.register(new EmbeddedDataSpecificationCollectionMapper());
         mappingProvider.register(new DataSpecificationIEC61360Mapper());
         mappingProvider.register(new EnumDataTypeIEC61360Mapper());
+        mappingProvider.register(new IdentifierKeyValuePairCollectionMapper());
+
         AbstractClassNamingStrategy classNamingStrategy = new NumberingClassNamingStrategy();
 
         PropertyNamingStrategy propertyNamingStrategy = new PropertyNamingStrategy();
         propertyNamingStrategy.registerCustomNaming(Referable.class, "descriptions", "description");
         propertyNamingStrategy.registerCustomNaming(MultiLanguageProperty.class, "values", "value");
-        propertyNamingStrategy.registerCustomNaming(Qualifiable.class, "qualifiers", "qualifier","qualifier");
+        propertyNamingStrategy.registerCustomNaming(Qualifiable.class, "qualifiers", "qualifier", "qualifier");
+        propertyNamingStrategy.registerCustomNaming(AssetInformation.class, "specificAssetIds", "specificAssetId");
         MappingContext context = new MappingContext(mappingProvider, classNamingStrategy, propertyNamingStrategy, config.getTypeFactory());
         context.setDocumentInfo(AmlDocumentInfo.fromFile(aml));
         AssetAdministrationShellEnvironment result = context.map(AssetAdministrationShellEnvironment.class, parser);

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

@@ -73,7 +73,7 @@ public AssetAdministrationShellEnvironment map(AmlParser parser, MappingContext
         CAEXFile.SystemUnitClassLib systemUnitClassLib = parser.getContent().getSystemUnitClassLib().stream()
                 .filter(x -> x.getName().equalsIgnoreCase(ASSET_ADMINISTRATION_SHELL_SYSTEM_UNIT_CLASSES))
                 .findFirst()
-                .orElse(null);
+                .orElse(CAEXFile.SystemUnitClassLib.builder().build());
 
         List<SystemUnitFamilyType> systemUnitFamilyTypeShells = systemUnitClassLib.getSystemUnitClass().stream()
                 .filter(x ->x.getSupportedRoleClass().get(0).getRefRoleClassPath().equalsIgnoreCase(ROLE_CLASS_LIB_ASSET_ADMINISTRATION_SHELL))

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

@@ -0,0 +1,82 @@
+/*
+ * 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.deserialization.mappers;
+
+import io.adminshell.aas.v3.dataformat.aml.deserialization.AmlParser;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.DefaultMapper;
+import io.adminshell.aas.v3.dataformat.aml.deserialization.MappingContext;
+import io.adminshell.aas.v3.dataformat.aml.model.caex.AttributeType;
+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.IdentifierKeyValuePair;
+import java.beans.PropertyDescriptor;
+
+import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+public class IdentifierKeyValuePairCollectionMapper extends DefaultMapper<Collection<IdentifierKeyValuePair>> {
+
+    @Override
+    protected Collection mapCollectionValueProperty(AmlParser parser, MappingContext context) throws MappingException {
+        Collection result = new ArrayList<>();
+        CAEXObject current = parser.getCurrent();
+        AttributeType parent = findAttribute(current, context.getProperty(), context);
+        if (parent == null) {
+            return result;
+        }
+        List<AttributeType> attributes = findAttributes(parent, x -> x.getName().startsWith("specificAssetId"));
+        for (AttributeType attribute : attributes) {
+            parser.setCurrent(attribute);
+            try {
+                IdentifierKeyValuePair element = context.getTypeFactory().newInstance(IdentifierKeyValuePair.class);
+                for (PropertyDescriptor property : AasUtils.getAasProperties(IdentifierKeyValuePair.class)) {
+                    Object propertyValue = context
+                            .with(element)
+                            .with(property)
+                            .withoutType()
+                            .map(property.getReadMethod().getGenericReturnType(), parser);
+                    if (propertyValue != null) {
+                        try {
+                            property.getWriteMethod().invoke(element, propertyValue);
+                        } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException ex) {
+                            throw new MappingException(String.format("error setting property value for property %s", property.getName()), ex);
+                        }
+                    }
+                }
+                parser.setCurrent(attribute);
+                result.add(element);
+            } catch (NoSuchMethodException ex) {
+                Logger.getLogger(IdentifierKeyValuePairCollectionMapper.class.getName()).log(Level.SEVERE, null, ex);
+            } catch (InstantiationException ex) {
+                Logger.getLogger(IdentifierKeyValuePairCollectionMapper.class.getName()).log(Level.SEVERE, null, ex);
+            } catch (IllegalAccessException ex) {
+                Logger.getLogger(IdentifierKeyValuePairCollectionMapper.class.getName()).log(Level.SEVERE, null, ex);
+            } catch (IllegalArgumentException ex) {
+                Logger.getLogger(IdentifierKeyValuePairCollectionMapper.class.getName()).log(Level.SEVERE, null, ex);
+            } catch (InvocationTargetException ex) {
+                Logger.getLogger(IdentifierKeyValuePairCollectionMapper.class.getName()).log(Level.SEVERE, null, ex);
+            }
+        }
+        parser.setCurrent(parent);
+        return result;
+    }
+
+}

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

@@ -38,6 +38,7 @@
 import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.ViewMapper;
 import io.adminshell.aas.v3.dataformat.aml.model.caex.CAEXFile;
 import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.ConceptDescriptionMapper;
+import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.IdentifierKeyValuePairCollectionMapper;
 import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.PropertyMapper;
 import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.RangeMapper;
 import io.adminshell.aas.v3.dataformat.aml.serialization.mappers.ReferenceMapper;
@@ -99,6 +100,7 @@ public CAEXFile map(AssetAdministrationShellEnvironment env, AmlSerializationCon
         mappingProvider.register(new PropertyMapper());
         mappingProvider.register(new RangeMapper());
         mappingProvider.register(new ConceptDescriptionMapper());
+        mappingProvider.register(new IdentifierKeyValuePairCollectionMapper());
         MappingContext context = new MappingContext(
                 mappingProvider,
                 classNamingStrategy,

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

@@ -0,0 +1,69 @@
+/*
+ * 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.serialization.mappers;
+
+import io.adminshell.aas.v3.dataformat.aml.serialization.DefaultMapper;
+import io.adminshell.aas.v3.dataformat.aml.serialization.AmlGenerator;
+import io.adminshell.aas.v3.dataformat.aml.serialization.MappingContext;
+import io.adminshell.aas.v3.dataformat.aml.model.caex.AttributeType;
+import io.adminshell.aas.v3.dataformat.core.util.AasUtils;
+import io.adminshell.aas.v3.dataformat.mapping.MappingException;
+import io.adminshell.aas.v3.model.AssetInformation;
+import io.adminshell.aas.v3.model.IdentifierKeyValuePair;
+import java.beans.PropertyDescriptor;
+import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class IdentifierKeyValuePairCollectionMapper extends DefaultMapper<Collection<IdentifierKeyValuePair>> {
+
+    private static final String ATTRIBUTE_NAME = "specificAssetId";
+
+    @Override
+    public void map(Collection<IdentifierKeyValuePair> value, AmlGenerator generator, MappingContext context) throws MappingException {
+        if (value == null || context == null || value.isEmpty()) {
+            return;
+        }
+        AttributeType.Builder wrapperBuilder = AttributeType.builder()
+                .withName(ATTRIBUTE_NAME)
+                .withRefSemantic(generator.refSemantic(AssetInformation.class, ATTRIBUTE_NAME));
+        List<AttributeType> attributes = new ArrayList<>();
+        for (IdentifierKeyValuePair element : value) {
+            AttributeType.Builder builder = AttributeType.builder()
+                    .withName(ATTRIBUTE_NAME + (value.size() > 1 ? "_" + (attributes.size() + 1) : ""));
+            for (PropertyDescriptor property : AasUtils.getAasProperties(element.getClass())) {
+                if (!skipProperty(property)) {
+                    context.with(property)
+                            .map(property.getReadMethod().getGenericReturnType(),
+                                    getElemenetPropertyValue(element, property, context),
+                                    generator.with(builder));
+                }
+            }
+            attributes.add(builder.build());
+        }
+        attributes.forEach(x -> wrapperBuilder.addAttribute(x));
+        generator.add(wrapperBuilder.build());
+    }
+
+    protected Object getElemenetPropertyValue(IdentifierKeyValuePair elemenet, PropertyDescriptor property, MappingContext context) throws MappingException {
+        try {
+            return property.getReadMethod().invoke(elemenet);
+        } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException ex) {
+            throw new MappingException("failed to get property value for property " + property.getName(), ex);
+        }
+    }
+}