Skip to content

Commit

Permalink
doc: update LDIO naming (#489)
Browse files Browse the repository at this point in the history
Co-authored-by: Yalz <[email protected]>
  • Loading branch information
Yalz and Yalz authored Feb 9, 2024
1 parent 79b7b4a commit 221de2a
Show file tree
Hide file tree
Showing 25 changed files with 76 additions and 59 deletions.
6 changes: 3 additions & 3 deletions docs/_ldio/examples/ex1-basicHttp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/_ldio/examples/ex2-scrape-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
14 changes: 7 additions & 7 deletions docs/_ldio/examples/ex3-enrich-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/>
Expand All @@ -100,7 +100,7 @@ orchestrator:
}
"
outputs:
- name: "be.vlaanderen.informatievlaanderen.ldes.ldio.LdioConsoleOut"
- name: "Ldio:ConsoleOut"
```
## Execution
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-adapters/ldio-json-to-json-ld.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-adapters/ldio-ngsiv2-to-ld.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-adapters/ldio-rdf-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-adapters/ldio-rml-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/_ldio/ldio-inputs/ldio-amqp-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-inputs/ldio-archive-file-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions docs/_ldio/ldio-inputs/ldio-http-in-poller.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-inputs/ldio-http-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 4 additions & 3 deletions docs/_ldio/ldio-inputs/ldio-kafka-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/_ldio/ldio-inputs/ldio-ldes-client-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/_ldio/ldio-inputs/ldio-ldes-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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)

Expand All @@ -33,7 +33,7 @@ Refer to [LDIO Http Requester](../ldio-core) for the config.

```yaml
input:
name: be.vlaanderen.informatievlaanderen.ldes.ldi.client.LdioLdesClient
name: Ldio:LdesClient
config:
urls:
- http://localhost:8080/my-ldes
Expand All @@ -49,7 +49,7 @@ Refer to [LDIO Http Requester](../ldio-core) for the config.
```yaml
input:
name: be.vlaanderen.informatievlaanderen.ldes.ldi.client.LdioLdesClient
name: Ldio:LdesClient
config:
urls:
- http://localhost:8080/my-ldes
Expand Down
6 changes: 3 additions & 3 deletions docs/_ldio/ldio-outputs/ldio-azure-blob-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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"
Expand All @@ -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"
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-outputs/ldio-console-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-outputs/ldio-file-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-outputs/ldio-http-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: HTTP Out
---

# LDIO HTTP Out
***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioHttpOut***

***Ldio:HttpOut***

The LDIO HTTP Out is a basic Http Client that will send the given Linked Data model to a target url.

Expand Down
7 changes: 4 additions & 3 deletions docs/_ldio/ldio-outputs/ldio-kafka-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: Kafka Out
---

# LDIO Kafka Out
***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaOut***

***Ldio:KafkaOut***

The LDIO Kafka Out sends messages to a [kafka topic](https://kafka.apache.org).
Two security protocols are supported:
Expand All @@ -31,7 +32,7 @@ Two security protocols are supported:

```yaml
outputs:
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaOut
- name: Ldio:KafkaOut
config:
bootstrap-servers: localhost:9092
topic: quickstart-events
Expand All @@ -42,7 +43,7 @@ outputs:
```yaml
outputs:
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaOut
- name: Ldio:KafkaOut
config:
bootstrap-servers: localhost:9092
topic: quickstart-events
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-outputs/ldio-repository-materialiser.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: Repository Materialization
---

# Repository Materialiser
***be.vlaanderen.informatievlaanderen.ldes.ldi.RepositoryMaterialiser***

***Ldio:RepositoryMaterialiser***

The repository materialiser is used to materialise an LDES stream into a triplestore.
Any triplestore that supports the RDF4J remote repository API can be used.
Expand Down
3 changes: 2 additions & 1 deletion docs/_ldio/ldio-transformers/ldio-geojson-to-wkt.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: GeoJson To WKT Transformer
---

# LDIO GeoJson To WKT Transformer
***be.vlaanderen.informatievlaanderen.ldes.ldi.GeoJsonToWktTransformer***

***Ldio:GeoJsonToWktTransformer***

An LDIO wrapper component for the [LDI GeoJson to Wkt building block](../../core/ldi-transformers/geojson-to-wkt)

Expand Down
Loading

0 comments on commit 221de2a

Please sign in to comment.