feat: update DSP-Tools to support ArchiveRepresentation (DEV-259) (#128)

dasch-swiss · Nov 29, 2021 · 85a40c2 · 85a40c2
1 parent 0dc724c
commit 85a40c2
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 3 deletions.
diff --git a/docs/dsp-tools-create.md b/docs/dsp-tools-create.md
@@ -1078,6 +1078,7 @@ The following predefined resources are provided by DSP:
 - `DDDRepresentation`: An object representing a 3-D representation (not yet implemented)
 - `DocumentRepresentation`: An object representing an opaque document (e.g. a PDF)
 - `MovingImageRepresentation`: An object representing a moving image (video, film)
+- `ArchiveRepresentation`: An object representing a archive file (e.g. Zip)
 - `Annotation`: A predefined annotation object. It has automatically the following predefined properties defined:
     - `hasComment` (1-n)
     - `isAnnotationOf` (1)

diff --git a/knora/dsplib/models/resource.py b/knora/dsplib/models/resource.py
@@ -45,6 +45,7 @@ class ResourceInstance(Model):
         'AudioRepresentation',
         'DocumentRepresentation',
         'MovingImageRepresentation',
+        'ArchiveRepresentation',
         'DDDRepresentation',
         'TextRepresentation'}
     knora_properties: Set[str] = {
@@ -228,6 +229,11 @@ def toJsonLdObj(self, action: Actions) -> Any:
                         "@type": "knora-api:AudioFileValue",
                         "knora-api:fileValueHasFilename": self._bitstream
                     }
+                elif self.baseclass == 'ArchiveRepresentation':
+                    tmp["knora-api:hasArchiveFileValue"] = {
+                        "@type": "knora-api:ArchiveFileValue",
+                        "knora-api:fileValueHasFilename": self._bitstream
+                    }
                 else:
                     raise BaseError(f'Baseclass "{self.baseclass}" not yet supported!')
             for propname, valtype in self._values.items():

diff --git a/knora/dsplib/schemas/ontology.json b/knora/dsplib/schemas/ontology.json
@@ -56,6 +56,7 @@
                         "DDDRepresentation",
                         "DocumentRepresentation",
                         "MovingImageRepresentation",
+                        "ArchiveRepresentation",
                         "Annotation",
                         "LinkObj",
                         "Region"

diff --git a/knora/dsplib/schemas/resources-only.json b/knora/dsplib/schemas/resources-only.json
@@ -44,6 +44,7 @@
                         "DDDRepresentation",
                         "DocumentRepresentation",
                         "MovingImageRepresentation",
+                        "ArchiveRepresentation",
                         "Annotation",
                         "LinkObj",
                         "Region"

diff --git a/knora/knora.py b/knora/knora.py
@@ -34,6 +34,7 @@
  - :DDDRepresentation
  - :DocumentRepresentation
  - :MovingImageRepresentation
+ - :ArchiveRepresentation
  - :Annotation -> :hasComment, :isAnnotationOf, :isAnnotationOfValue
  - :LinkObj -> :hasComment, :hasLinkTo, :hasLinkToValue
  - :LinkValue [reification node]

diff --git a/testdata/test-onto.json b/testdata/test-onto.json
@@ -104,8 +104,7 @@
                 "groups": [
                     ":testgroup"
                 ],
-                "projects": [
-                ]
+                "projects": []
             }
         ],
         "ontologies": [
@@ -475,7 +474,7 @@
                     },
                     {
                         "name": "ZipThing",
-                        "super": "DocumentRepresentation",
+                        "super": "ArchiveRepresentation",
                         "labels": {
                             "en": "A ZIP Thing"
                         },