You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
-
# JVM Runner Plugin for RDF Connect
1
+
# JVM Runner for RDF Connect
2
2
3
3
The **JvmRunner** executes processors implemented in the Java Virtual Machine (JVM).
4
-
It allows you to integrate custom Java (or Kotlin, Scala, etc.) processors into an RDFConnect streaming pipeline by providing a JAR and a class name.
4
+
It allows you to integrate custom Java (or Kotlin, Scala, etc.) processors into an RDF-Connect streaming pipeline by providing a JAR and a class name.
5
5
6
6
## Overview
7
7
@@ -34,6 +34,8 @@ To use your JVM processor in a pipeline:
34
34
<myProcessor> a rdfc:TestProcessor.
35
35
```
36
36
37
+
Make sure you also import the processor. Check the documentation of your processor on how to install it.
38
+
37
39
38
40
## Implementing a new processor
39
41
@@ -48,7 +50,7 @@ Processors must:
48
50
49
51
### Processor description file
50
52
51
-
The processor should be accompanied with a description file, often called `index.ttl`.
53
+
The processor should be accompanied by a description file, often called `index.ttl`.
52
54
53
55
They require the following fields:
54
56
*`rdfc:javaImplementationOf` with value `rdfc:Processor`, indicating that this processor is a JavaProcessor,
@@ -57,7 +59,7 @@ They require the following fields:
57
59
* A SHACL shape defining the required arguments.
58
60
59
61
For example, the following description file declares a processor with arguments `{ reader: Reader, writer: Writer, additionalText: string }`.
60
-
A matching implementation can be found on [github](https://github.com/rdf-connect/template-processor-jvm/blob/main/src/main/java/org/example/Library.java).
62
+
A matching implementation can be found on [GitHub](https://github.com/rdf-connect/template-processor-jvm/blob/main/src/main/java/org/example/Library.java).
0 commit comments