rel: Linked Data Interactions 2.0 (#478)

Informatievlaanderen · Feb 9, 2024 · f0be02c · f0be02c
2 parents 9757d36 + 221de2a
commit f0be02c
Show file tree

Hide file tree

Showing 182 changed files with 1,083 additions and 432 deletions.
diff --git a/docs/_core/ldi-inputs/ldes-client.md b/docs/_core/ldi-inputs/ldes-client.md
@@ -16,4 +16,6 @@ It will be ignored when an attempt is made to queue a known immutable fragment.
 
 Processed members of mutable fragments are also kept in state. They are ignored if presented more than once.
 
-[VSDS Tech Docs]: https://informatievlaanderen.github.io/VSDS-Tech-Docs/introduction/LDES_client
+Within a fragment, members can be ordered based on a timestamp. The path to this timestamp has to be configured. If this path is missing, the members are ordered randomly.
+
+[VSDS Tech Docs]: https://informatievlaanderen.github.io/VSDS-Tech-Docs/introduction/LDES_client
diff --git a/docs/_ldio/examples/ex1-basicHttp.md b/docs/_ldio/examples/ex1-basicHttp.md
@@ -23,11 +23,11 @@ orchestrator:
     - name: data
       description: "This pipeline uses a HTTP listener to read incoming RDF data and writes them to the console"
       input:
-        name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpIn
+        name: Ldio:HttpIn
         adapter:
-          name: be.vlaanderen.informatievlaanderen.ldes.ldi.RdfAdapter
+          name: Ldio:RdfAdapter
       outputs:
-        - name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioConsoleOut
+        - name: Ldio:ConsoleOut
 ````
 
 ## Execution

diff --git a/docs/_ldio/examples/ex2-scrape-api.md b/docs/_ldio/examples/ex2-scrape-api.md
@@ -70,23 +70,23 @@ orchestrator:
   pipelines:
     - name: data
       input:
-        name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpInPoller
+        name: Ldio:HttpInPoller
         config:
           url: https://www.cheapshark.com/api/1.0/deals?pageSize=1000
           interval: PT30M
         adapter:
-          name: be.vlaanderen.informatievlaanderen.ldes.ldi.RmlAdapter
+          name: Ldio:RmlAdapter
           config:
             mapping: "mapping.ttl"
       transformers:
-        - name: be.vlaanderen.informatievlaanderen.ldes.ldi.VersionObjectCreator
+        - name: Ldio:VersionObjectCreator
           config:
             date-observed-property: "http://www.cheapshark.com/lastChange"
             member-type: "http://www.cheapshark.com/GameDeal"
             generatedAt-property: "https://w3id.org/ldes#timestampPath"
             versionOf-property: "https://w3id.org/ldes#versionOfPath"
       outputs:
-        - name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioConsoleOut
+        - name: Ldio:ConsoleOut
           config:
             content-type: text/turtle
 ```

diff --git a/docs/_ldio/examples/ex3-enrich-model.md b/docs/_ldio/examples/ex3-enrich-model.md
@@ -68,21 +68,21 @@ orchestrator:
   pipelines:
     - name: "to-graph"
       input:
-        name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpIn"
+        name: "Ldio:HttpIn"
         adapter:
-          name: "be.vlaanderen.informatievlaanderen.ldes.ldi.RdfAdapter"
+          name: "Ldio:RdfAdapter"
       outputs:
-        - name: "be.vlaanderen.informatievlaanderen.ldes.ldi.RepositoryMaterialiser"
+        - name: "Ldio:RepositoryMaterialiser"
           config:
             sparql-host: http://localhost:8081/rdf4j-server
             repository-id: test
     - name: "enriched"
       input:
-        name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpIn"
+        name: "Ldio:HttpIn"
         adapter:
-          name: "be.vlaanderen.informatievlaanderen.ldes.ldi.RdfAdapter"
+          name: "Ldio:RdfAdapter"
       transformers:
-        - name: "be.vlaanderen.informatievlaanderen.ldes.ldi.SparqlConstructTransformer"
+        - name: "Ldio:SparqlConstructTransformer"
           config:
             query: "
               PREFIX schema: <http://schema.org/>
@@ -100,7 +100,7 @@ orchestrator:
               }
             "
       outputs:
-        - name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdioConsoleOut"
+        - name: "Ldio:ConsoleOut"
 ```
 
 ## Execution

diff --git a/docs/_ldio/ldio-adapters/ldio-json-to-json-ld.md b/docs/_ldio/ldio-adapters/ldio-json-to-json-ld.md
@@ -5,7 +5,8 @@ title: Json To JsonLd Transformer
 ---
 
 # LDIO Json To JsonLd Transformer
-***be.vlaanderen.informatievlaanderen.ldes.ldi.JsonToLdAdapter***
+
+***Ldio:JsonToLdAdapter***
 
 An LDIO wrapper component for the [LDI Json To JsonLd building block](../../_core/ldi-adapters/json-to-json-ld)
 

diff --git a/docs/_ldio/ldio-adapters/ldio-ngsiv2-to-ld.md b/docs/_ldio/ldio-adapters/ldio-ngsiv2-to-ld.md
@@ -5,7 +5,8 @@ title: NGSIv2 To LD Adapter
 ---
 
 # LDIO NGSIv2 To LD Adapter
-***be.vlaanderen.informatievlaanderen.ldes.ldi.NgsiV2ToLdAdapter***
+
+***Ldio:NgsiV2ToLdAdapter***
 
 An LDIO wrapper component for the [LDI NGSIv2 To LD building block](../../core/ldi-adapters/ngsiv2-to-ld)
 

diff --git a/docs/_ldio/ldio-adapters/ldio-rdf-adapter.md b/docs/_ldio/ldio-adapters/ldio-rdf-adapter.md
@@ -5,7 +5,8 @@ title: RDF Adapter
 ---
 
 # LDIO RDF Adapter
-***be.vlaanderen.informatievlaanderen.ldes.ldi.RdfAdapter***
+
+***Ldio:RdfAdapter***
 
 An LDIO wrapper component for the [LDI RDF Adapter building block](../../core/ldi-adapters/rdf-adapter)
 

diff --git a/docs/_ldio/ldio-adapters/ldio-rml-adapter.md b/docs/_ldio/ldio-adapters/ldio-rml-adapter.md
@@ -5,7 +5,8 @@ title: RML Adapter
 ---
 
 # LDIO RML Adapter
-***be.vlaanderen.informatievlaanderen.ldes.ldi.RmlAdapter***
+
+***Ldio:RmlAdapter***
 
 An LDIO wrapper component for the [LDI RML Adapter building block](../../core/ldi-adapters/rml-adapter)
 

diff --git a/docs/_ldio/ldio-inputs/ldio-amqp-in.md b/docs/_ldio/ldio-inputs/ldio-amqp-in.md
@@ -6,7 +6,7 @@ title: AMQP In
 
 # LDIO AMQP In
 
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioAmqpIn***
+***Ldio:AmqpIn***
 
 The LDIO AMQP In listens to messages from
 an [AMQP 1.0 queue](https://www.amqp.org/resources/specifications).
@@ -25,7 +25,7 @@ an [AMQP 1.0 queue](https://www.amqp.org/resources/specifications).
 
 ```yaml
       input:
-        name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioAmqpIn
+        name: Ldio:AmqpIn
         config:
           remote-url: amqp://localhost:61616
           username: artemis

diff --git a/docs/_ldio/ldio-inputs/ldio-archive-file-in.md b/docs/_ldio/ldio-inputs/ldio-archive-file-in.md
@@ -5,7 +5,8 @@ title: Archive File In
 ---
 
 # LDIO File Out
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioArchiveFileIn***
+
+***Ldio:ArchiveFileIn***
 
 The LDIO Archive File In is used to read models from files and feed them to the pipeline.
 Please refer to the [core documentation](../../core/ldi-inputs/file-archiving.md) for more information.

diff --git a/docs/_ldio/ldio-inputs/ldio-http-in-poller.md b/docs/_ldio/ldio-inputs/ldio-http-in-poller.md
@@ -5,7 +5,8 @@ title: HTTP In Poller
 ---
 
 # LDIO HTTP In Poller
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpInPoller***
+
+***Ldio:HttpInPoller***
 
 The LDIO Http In Poller is a basic Http Poller that will poll a target URL on a specified interval. 
 
@@ -24,7 +25,7 @@ Refer to [LDIO Http Requester](../ldio-core) for the config.
 The Http In Poller supports polling multiple endpoints. Example configuration:
 
 ```yaml
-name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpInPoller
+name: Ldio:HttpInPoller
 config:
   auth:
     type: API_KEY

diff --git a/docs/_ldio/ldio-inputs/ldio-http-in.md b/docs/_ldio/ldio-inputs/ldio-http-in.md
@@ -5,7 +5,8 @@ title: HTTP In
 ---
 
 # LDIO HTTP In
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpIn***
+
+***Ldio:HttpIn***
 
 The LDIO Http In is a basic Http Listener. 
 

diff --git a/docs/_ldio/ldio-inputs/ldio-kafka-in.md b/docs/_ldio/ldio-inputs/ldio-kafka-in.md
@@ -5,7 +5,8 @@ title: Kafka In
 ---
 
 # LDIO Kafka In
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaIn***
+
+***Ldio:KafkaIn***
 
 The LDIO Kafka In listens to messages from a [kafka topic](https://kafka.apache.org).
 
@@ -31,7 +32,7 @@ Two security protocols are supported:
 
 ```yaml
 outputs:
-  - name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaIn
+  - name: Ldio:KafkaIn
     config:
       content-type: application/n-quads
       topics: quickstart-events
@@ -42,7 +43,7 @@ outputs:
 
 ```yaml
 outputs:
-  - name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaIn
+  - name: Ldio:KafkaIn
     config:
       content-type: application/n-quads
       topics: quickstart-events

diff --git a/docs/_ldio/ldio-inputs/ldio-ldes-client-connector.md b/docs/_ldio/ldio-inputs/ldio-ldes-client-connector.md
@@ -6,7 +6,7 @@ title: LDES Client with Connector
 
 # LDIO Ldes Client Connector
 
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioLdesClientConnector***
+***Ldio:LdesClientConnector***
 
 An EDC (Eclipse dataspace Connector) LDIO wrapper component for
 the [LDI LDES Client building block](../../core/ldi-inputs/ldes-client)
@@ -45,7 +45,7 @@ This component exposes two endpoints:
 
 ```yaml
 input:
-   name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioLdesClientConnector
+   name: Ldio:LdesClientConnector
    config:
       url: http://consumer-connector:29291/public
       connector-transfer-url: http://consumer-connector:29193/management/v2/transferprocesses

diff --git a/docs/_ldio/ldio-inputs/ldio-ldes-client.md b/docs/_ldio/ldio-inputs/ldio-ldes-client.md
@@ -6,24 +6,25 @@ title: LDES Client
 
 # LDIO Ldes Client
 
-***be.vlaanderen.informatievlaanderen.ldes.ldi.client.LdioLdesClient***
+***Ldio:LdesClient***
 
 An LDIO wrapper component for the [LDI LDES Client building block](../../core/ldi-inputs/ldes-client)
 
 ## Config
 
-| Property                     | Description                                                                                                                                                                                 | Required | Default                               | Example                                                        | Supported values                                              |
-|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|:--------------------------------------|:---------------------------------------------------------------|:--------------------------------------------------------------|
-| url                          | The url of the LDES server                                                                                                                                                                  | Yes      | N/A                                   | http://localhost:8080/my-ldes                                  | HTTP and HTTPS urls                                           |
-| source-format                | The 'Content-Type' that should be requested to the server.                                                                                                                                  | No       | application/ld+json                   | application/n-quads                                            | Any type supported by [Apache Jena](https://jena.apache.org/) |
-| state                        | 'sqlite', 'memory', 'file' or 'postgres' to indicate how the state should be persisted.                                                                                                     | No       | memory                                | sqlite                                                         | 'sqlite' or 'memory'                                          |
-| keep-state                   | Indicates if the state should be persisted on shutdown (n/a for in memory states)                                                                                                           | No       | false                                 | false                                                          | true or false                                                 |
-| postgres.url                 | JDBC url of the Postgres database.                                                                                                                                                          | No       | N/A                                   | jdbc:postgresql://test.postgres.database.azure.com:5432/sample | String                                                        |
-| postgres.username            | Username used to connect to Postgres database.                                                                                                                                              | No       | N/A                                   | myUsername@test                                                | String                                                        |
-| postgres.password            | Password used to connect to Postgres database.                                                                                                                                              | No       | N/A                                   | myPassword                                                     | String                                                        |
-| use-version-materialisation  | Indicates if the client should return state-objects (true) or version-objects (false).                                                                                                      | No       | false                                 | true                                                           | true or false                                                 |
-| version-of-property          | Property that points to the versionOfPath.                                                                                                                                                  | No       | http://purl.org/dc/terms/isVersionOf  | "http://purl.org/dc/terms/isVersionOf"                         | true or false                                                 |
-| restrict-to-members          | Indicates that only the statements about the ldes:member should be included, including potential nested blank nodes. If this is enabled, statements about referenced entities are excluded. | No       | false                                 | false                                                          | true or false                                                 |
+| Property                    | Description                                                                                                                                                                                 | Required | Default                              | Example                                                        | Supported values                                              |
+|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|:-------------------------------------|:---------------------------------------------------------------|:--------------------------------------------------------------|
+| urls                        | List of URLs of the LDES data sources                                                                                                                                                       | Yes      | N/A                                  | http://localhost:8080/my-ldes                                  | HTTP and HTTPS urls                                           |
+| source-format               | The 'Content-Type' that should be requested to the server.                                                                                                                                  | No       | application/ld+json                  | application/n-quads                                            | Any type supported by [Apache Jena](https://jena.apache.org/) |
+| state                       | 'sqlite', 'memory', 'file' or 'postgres' to indicate how the state should be persisted.                                                                                                     | No       | memory                               | sqlite                                                         | 'sqlite', 'files' or 'memory'                                 |
+| keep-state                  | Indicates if the state should be persisted on shutdown (n/a for in memory states)                                                                                                           | No       | false                                | false                                                          | true or false                                                 |
+| postgres.url                | JDBC url of the Postgres database.                                                                                                                                                          | No       | N/A                                  | jdbc:postgresql://test.postgres.database.azure.com:5432/sample | String                                                        |
+| postgres.username           | Username used to connect to Postgres database.                                                                                                                                              | No       | N/A                                  | myUsername@test                                                | String                                                        |
+| postgres.password           | Password used to connect to Postgres database.                                                                                                                                              | No       | N/A                                  | myPassword                                                     | String                                                        |
+| timestamp-path              | The property-path used to determine the timestamp on which the members will be ordered                                                                                                      | No       | N/A                                  | http://www.w3.org/ns/prov#generatedAtTime                      | A property path                                               |
+| use-version-materialisation | Indicates if the client should return state-objects (true) or version-objects (false).                                                                                                      | No       | false                                | true                                                           | true or false                                                 |
+| version-of-property         | Property that points to the versionOfPath.                                                                                                                                                  | No       | http://purl.org/dc/terms/isVersionOf | "http://purl.org/dc/terms/isVersionOf"                         | true or false                                                 |
+| restrict-to-members         | Indicates that only the statements about the ldes:member should be included, including potential nested blank nodes. If this is enabled, statements about referenced entities are excluded. | No       | false                                | false                                                          | true or false                                                 |
 
 This component uses the "LDIO Http Requester" to make the HTTP request.
 Refer to [LDIO Http Requester](../ldio-core) for the config.
@@ -32,9 +33,10 @@ Refer to [LDIO Http Requester](../ldio-core) for the config.
 
 ```yaml
   input:
-    name: be.vlaanderen.informatievlaanderen.ldes.ldi.client.LdioLdesClient
+    name: Ldio:LdesClient
     config:
-      url: http://localhost:8080/my-ldes
+      urls:
+        - http://localhost:8080/my-ldes
       sourceFormat: text/turtle
       retries:
         enabled: true
@@ -47,9 +49,10 @@ Refer to [LDIO Http Requester](../ldio-core) for the config.
 
 ```yaml
   input:
-    name: be.vlaanderen.informatievlaanderen.ldes.ldi.client.LdioLdesClient
+    name: Ldio:LdesClient
     config:
-      url: http://localhost:8080/my-ldes
+      urls:
+        - http://localhost:8080/my-ldes
       sourceFormat: text/turtle
       retries:
         enabled: true

diff --git a/docs/_ldio/ldio-outputs/ldio-azure-blob-out.md b/docs/_ldio/ldio-outputs/ldio-azure-blob-out.md
@@ -6,7 +6,7 @@ title: Azure Blob Out
 
 # LDIO Kafka Out
 
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdiAzureBlobOut***
+***Ldio:AzureBlobOut***
 
 The LDIO Azure Blob Out writes out messages to an Azure Blob Container.
 Messages can be written out in any format supported by Apache Jena or in json format.
@@ -29,7 +29,7 @@ Messages can be written out in any format supported by Apache Jena or in json fo
 
 ```yaml
 outputs:
-  - name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdiAzureBlobOut"
+  - name: "Ldio:AzureBlobOut"
     config:
       lang: "json"
       storage-account-name: "storageaccount"
@@ -42,7 +42,7 @@ outputs:
 
 ```yaml
 outputs:
-  - name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdiAzureBlobOut"
+  - name: "Ldio:AzureBlobOut"
     config:
       lang: "n-quads"
       storage-account-name: "storageaccount"

diff --git a/docs/_ldio/ldio-outputs/ldio-console-out.md b/docs/_ldio/ldio-outputs/ldio-console-out.md
@@ -5,7 +5,8 @@ title: Console Out
 ---
 
 # LDIO Console Out
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioConsoleOut***
+
+***Ldio:ConsoleOut***
 
 The LDIO Console Out will output its given model to the console.
 

diff --git a/docs/_ldio/ldio-outputs/ldio-file-out.md b/docs/_ldio/ldio-outputs/ldio-file-out.md
@@ -5,7 +5,8 @@ title: File Out
 ---
 
 # LDIO File Out
-***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioFileOut***
+
+***Ldio:FileOut***
 
 The LDIO File Out is used to write models to files based on a timestamp path property on the model.
 Please refer to the [core documentation](../../core/ldi-outputs/file-archiving.md) for more information.