checkpoint

ArangoDB-Community · Jan 23, 2024 · a9a0c4d · a9a0c4d
1 parent b22dee4
commit a9a0c4d
Show file tree

Hide file tree

Showing 16 changed files with 403 additions and 239 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,12 @@ adbrdf.rdf_to_arangodb_by_pgt(name="BeatlesPGT", rdf_graph=beatles(), overwrite_
 
 ### ArangoDB to RDF
 
+**Note**: RDF-to-ArangoDB functionality has been implemented using concepts described in the paper
+*[Transforming RDF-star to Property Graphs: A Preliminary Analysis of Transformation Approaches](https://arxiv.org/abs/2210.05781)*. So we offer two transformation approaches:
+
+1. RDF-Topology Preserving Transformation (RPT)
+2. Property Graph Transformation (PGT)
+
 ```py
 # 1. Graph to RDF
 rdf_graph = adbrdf.arangodb_graph_to_rdf(name="BeatlesRPT", rdf_graph=Graph())
@@ -116,76 +122,3 @@ def pytest_addoption(parser):
     parser.addoption("--username", action="store", default="root")
     parser.addoption("--password", action="store", default="")
 ```
-
-## Additional Info: RDF to ArangoDB
-
-RDF-to-ArangoDB functionality has been implemented using concepts described in the paper *[Transforming RDF-star to Property Graphs: A Preliminary Analysis of Transformation Approaches](https://arxiv.org/abs/2210.05781)*.
-
-In other words, `ArangoRDF` offers 2 RDF-to-ArangoDB transformation methods:
-1. RDF-topology Preserving Transformation (RPT): `ArangoRDF.rdf_to_arangodb_by_rpt()`
-2. Property Graph Transformation (PGT): `ArangoRDF.rdf_to_arangodb_by_pgt()`
-
-RPT preserves the RDF Graph structure by transforming each RDF Statement into an ArangoDB Edge.
-
-PGT on the other hand ensures that Datatype Property Statements are mapped as ArangoDB Document Properties.
-
-```ttl
-@prefix ex: <http://example.org/> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-ex:book ex:publish_date "1963-03-22"^^xsd:date .
-ex:book ex:pages "100"^^xsd:integer .
-ex:book ex:cover 20 .
-ex:book ex:index 55 .
-```
-
-| RPT | PGT |
-|:-------------------------:|:-------------------------:|
-| ![image](https://user-images.githubusercontent.com/43019056/232347662-ab48ebfb-e215-4aff-af28-a5915414a8fd.png) | ![image](https://user-images.githubusercontent.com/43019056/232347681-c899ef09-53c7-44de-861e-6a98d448b473.png) |
-
---------------------
-### RPT
-
-
-The `ArangoRDF.rdf_to_arangodb_by_rpt` method will store the RDF Resources of your RDF Graph under the following ArangoDB Collections:
-
-    - {graph_name}_URIRef: The Document collection for `rdflib.term.URIRef` resources.
-    - {graph_name}_BNode: The Document collection for`rdflib.term.BNode` resources.
-    - {graph_name}_Literal: The Document collection for `rdflib.term.Literal` resources.
-    - {graph_name}_Statement: The Edge collection for all triples/quads.
-
---------------------
-### PGT
-
-In contrast to RPT, the `ArangoRDF.rdf_to_arangodb_by_pgt` method will rely on the nature of the RDF Resource/Statement to determine which ArangoDB Collection it belongs to. This is referred as the **ArangoDB Collection Mapping Process**. This process relies on 2 fundamental URIs:
-
-1) `<http://www.arangodb.com/collection>` (adb:collection)
-    - Any RDF Statement of the form `<http://example.com/Bob> <adb:collection> "Person"` will map the Subject to the ArangoDB "Person" document collection.
-
-2) `<http://www.w3.org/1999/02/22-rdf-syntax-ns#type>` (rdf:type)
-    - This strategy is divided into 3 cases:
-
-        1. If an RDF Resource only has one `rdf:type` statement,
-            then the local name of the RDF Object is used as the ArangoDB
-            Document Collection name. For example,
-            `<http://example.com/Bob> <rdf:type> <http://example.com/Person>`
-            would create an JSON Document for `<http://example.com/Bob>`,
-            and place it under the `Person` Document Collection.
-            NOTE: The RDF Object will also have its own JSON Document
-            created, and will be placed under the "Class"
-            Document Collection.
-
-        2. If an RDF Resource has multiple `rdf:type` statements,
-            with some (or all) of the RDF Objects of those statements
-            belonging in an `rdfs:subClassOf` Taxonomy, then the
-            local name of the "most specific" Class within the Taxonomy is
-            used (i.e the Class with the biggest depth). If there is a
-            tie between 2+ Classes, then the URIs are alphabetically
-            sorted & the first one is picked.
-
-        3. If an RDF Resource has multiple `rdf:type` statements, with none
-            of the RDF Objects of those statements belonging in an
-            `rdfs:subClassOf` Taxonomy, then the URIs are
-            alphabetically sorted & the first one is picked. The local
-            name of the selected URI will be designated as the Document
-            collection for that Resource.
---------------------
diff --git a/arango_rdf/__init__.py b/arango_rdf/__init__.py
@@ -1 +1,2 @@
 from arango_rdf.main import ArangoRDF  # noqa: F401
+from arango_rdf.controller import ArangoRDFController  # noqa: F401
diff --git a/docs/_static/cases.png b/docs/_static/cases.png
diff --git a/docs/_static/pgt_algorithm.png b/docs/_static/pgt_algorithm.png
diff --git a/docs/_static/pgt_star.png b/docs/_static/pgt_star.png
diff --git a/docs/_static/rpt_algorithm.png b/docs/_static/rpt_algorithm.png
diff --git a/docs/_static/rpt_star.png b/docs/_static/rpt_star.png
diff --git a/docs/contextualization.rst b/docs/contextualization.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -75,9 +75,6 @@ Contents
    :maxdepth: 1
 
    quickstart
-   rpt
-   pgt
-   mapping
-   contextualization
-   reification
+   rdf_to_arangodb_rpt
+   rdf_to_arangodb_pgt
    specs
diff --git a/docs/mapping.rst b/docs/mapping.rst
diff --git a/docs/pgt.rst b/docs/pgt.rst
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -22,6 +22,13 @@ Quickstart
 
 **ArangoDB to RDF**
 
+**Note**: RDF-to-ArangoDB functionality has been implemented using concepts described in the paper
+`Transforming RDF-star to Property Graphs: A Preliminary Analysis of Transformation Approaches 
+<https://arxiv.org/abs/2210.05781>`_. So we offer two transformation approaches:
+
+1. `RDF-Topology Preserving Transformation (RPT) <./rdf_to_arangodb_rpt.html>`_
+2. `Property Graph Transformation (PGT) <./rdf_to_arangodb_pgt.html>`_
+
 .. code-block:: python
 
    # 1. RDF-Topology Preserving Transformation (RPT)
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		from arango_rdf.main import ArangoRDF # noqa: F401
		from arango_rdf.controller import ArangoRDFController # noqa: F401