housekeeping and updating a couple of testfiles

eclipse-aas4j · Mar 2, 2023 · ef71ad8 · ef71ad8
1 parent e2243e2
commit ef71ad8
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ or by integrating the respective modules as dependencies from [Maven Central](ht
 <dependency>
 ```
 
-## Dataformat Library Project Structure
+## AAS4J Project Structure
 
 The project contains several modules:
 
@@ -57,8 +57,11 @@ The project contains several modules:
 - `dataformat-json` JSON de-/serializer
 - `dataformat-rdf` RDF de-/serializer
 - `dataformat-xml` XML de-/serializer
-- `dataformat-uanodeset` OPC UA I4AAS NodeSet de-/serializer
-- `dataformat-aml` AutomationML serializer (deserializer is currently under development)
+- `model` Meta-model classes be instantiated
+- `validator` Validator against the semantic restrictions of the AAS meta-model
+
+[AAS4J's predecessor](https://github.com/admin-shell-io/java-serializer) contained serialization modules for AutomationML
+and OPC UA for which however no longer up-to-date specifications exist. Implementation is halted until the specs have been updated.
 
 Additionally, the sources that are used for generating the static documentation using [DocFX](https://dotnet.github.io/docfx/) in the `gh-pages` branch are located in the `docs` folder.
 
@@ -73,22 +76,22 @@ We always look for contributions, bug reports, feature requests etc. Please, rea
 
 An updated list of the committers can be found here: https://projects.eclipse.org/projects/dt.aas4j/who
 
-| Name        | Affiliation           | Github Account | Parent | Core  | AASX | JSON | XML | RDF | UA-Nodeset | Validator| AutomationML
---- | --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---:
-| Mohammad Alreeni | Fraunhofer IWU | []() |  |  |  |  | x |  |  |  |
-| Sebastian Bader | Fraunhofer IAIS | [sebbader](https://github.com/sebbader) | x |  |  |  |  | x |  | x |  |
-| Matthias Böckmann | Fraunhofer IAIS | [maboeckmann](https://github.com/maboeckmann) | x |  |  |  |  | x |  | x |  |
-| Maximilian Conradi | Fraunhofer IESE | []() |  |  | x |  | x |  |  |  |  |
-| Helge Dickel | SAP SE | [heldic](https://github.com/heldic) | x |  |  | x | x |  |  |  |  |
-| Daniel Espen | Fraunhofer IESE | [daespen](https://github.com/daespen) |  | x | x | x | x |  |  |  |  |
-| Michael Jacoby | Fraunhofer IOSB| [mjacoby](https://github.com/mjacoby) | x | x |  | x | x |  |  |  | x |
-| Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) |  |  |  | x |  |  |  |  | x |
-| Orthodoxos Kipouridis | SAP SE | [akiskips](https://github.com/akiskips) | x |  |  | x | x |  |  |  |  |
-| Bastian Rössl | Fraunhofer IOSB-INA | [br-iosb](https://github.com/br-iosb) |  |  |  | x |  |  | x |  |  |
-| Frank Schnicke | Fraunhofer IESE | [frankschnicke](https://github.com/frankschnicke) |  |  | x |  | x |  |  | x |  |
-| Manuel Sauer | SAP SE | [Manu3756](https://github.com/Manu3756) | x |  |  |  |  |  |  |  |  |
-| Arno Weiss | Fraunhofer IWU | [alw-iwu](https://github.com/alw-iwu) |  |  |  | x |  |  | x |  |  |
-| Jan Blume | Fraunhofer IOSB | []() |  |  |  |  |  |  |  |  | x |
+| Name        | Affiliation           | Github Account                                        | Parent | Core  | AASX | JSON | XML | RDF | UA-Nodeset | Validator| AutomationML|
+|--- |-----------------------|-------------------------------------------------------| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---:|
+| Mohammad Alreeni | Fraunhofer IWU        | []()                                                  |  |  |  |  | x |  |  |  |
+| Sebastian Bader | Fraunhofer IAIS       | [sebbader](https://github.com/sebbader)               | x |  |  |  |  | x |  | x |  |
+| Matthias Böckmann | Fraunhofer IAIS       | [maboeckmann](https://github.com/maboeckmann)         | x |  |  |  |  | x |  | x |  |
+| Maximilian Conradi | Fraunhofer IESE       | []()                                                  |  |  | x |  | x |  |  |  |  |
+| Helge Dickel | SAP SE                | [heldic](https://github.com/heldic)                   | x |  |  | x | x |  |  |  |  |
+| Daniel Espen | Fraunhofer IESE       | [daespen](https://github.com/daespen)                 |  | x | x | x | x |  |  |  |  |
+| Michael Jacoby | Fraunhofer IOSB       | [mjacoby](https://github.com/mjacoby)                 | x | x |  | x | x |  |  |  | x |
+| Jens Müller | Fraunhofer IOSB       | [JensMueller2709](https://github.com/JensMueller2709) |  |  |  | x |  |  |  |  | x |
+| Orthodoxos Kipouridis | SAP SE                | [akiskips](https://github.com/akiskips)               | x |  |  | x | x |  |  |  |  |
+| Bastian Rössl | Fraunhofer IOSB-INA   | [br-iosb](https://github.com/br-iosb)                 |  |  |  | x |  |  | x |  |  |
+| Frank Schnicke | Fraunhofer IESE       | [frankschnicke](https://github.com/frankschnicke)     |  |  | x |  | x |  |  | x |  |
+| Manuel Sauer | SAP SE                | [Manu3756](https://github.com/Manu3756)               | x |  |  |  |  |  |  |  |  |
+| Arno Weiss | Fraunhofer IWU/SAP SE | [arnoweiss](https://github.com/arnoweiss)             |  |  |  | x |  |  | x |  |  |
+| 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.
diff --git a/...format-aasx/src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/aasx/AASXUtils.java b/...format-aasx/src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/aasx/AASXUtils.java
@@ -7,7 +7,7 @@ public class AASXUtils {
      * Gets the path from a URL e.g "http://localhost:8080/path/to/test.file"
      * results in "/path/to/test.file"
      *
-     * @param url
+     * @param url URL to get the path for
      * @return the path from the URL
      */
     public static String getPathFromURL(String url) {

diff --git a/...at-aasx/src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/aasx/AASXValidator.java b/...at-aasx/src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/aasx/AASXValidator.java
@@ -41,8 +41,8 @@ public AASXValidator(InputStream is) throws SAXException, IOException, InvalidFo
      * Calls XML-Validator
      * 
      * @return Set of Strings containing message on AASX-XML-Validation result
-     * @throws IOException
-     * @throws InvalidFormatException
+     * @throws IOException failure during filehandling
+     * @throws InvalidFormatException specified URI is invalid
      */
     public Set<String> validateSchema() throws IOException, InvalidFormatException {
         String file = deserializer.getXMLResourceString();

diff --git a/...src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/core/util/ReflectionHelper.java b/...src/main/java/org/eclipse/digitaltwin/aas4j/v3/dataformat/core/util/ReflectionHelper.java
@@ -175,6 +175,7 @@ public static boolean hasDefaultImplementation(Class<?> interfaceType) {
      * class is no aas interface or does not have default implementation
      *
      * @param interfaceType the interface to check
+     * @param <T> the implementing class
      * @return the default implementation type for given interfaceType or null
      * if the class is no aas interface or does not have default implementation
      */
@@ -410,7 +411,7 @@ private ReflectionHelper() {
 
     /**
      * Overrides empty list fields with null
-     * @param element
+     * @param element to perform the empty-to-null conversion on
      */
     public static void setEmptyListsToNull(Object element) {
 

diff --git a/pom.xml b/pom.xml
@@ -42,7 +42,7 @@
         <revision.patch>0</revision.patch>
         <revision.suffix>-milestone-01</revision.suffix>
         <revision>${revision.major}.${revision.minor}.${revision.patch}${revision.suffix}</revision>
-        <model.version>1.0.0-milestone-01</model.version>
+        <model.version>1.0.0-milestone-02-SNAPSHOT</model.version>
 
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>