Core module java rewrite

build.sbt

@@ -57,7 +57,9 @@ lazy val commonSettings = Seq(
     "-unchecked",
   ),
   javacOptions ++= Seq(
-    "-Werror",
+    "-source", "17",
+    // Currently, impossible to enable this without breaking the build due to warnings in protobuf generated code.
+    // "-Werror",
     // TODO: enable more warnings
     "-Xlint:unchecked",
   ),
@@ -83,6 +85,59 @@ lazy val rdfProtos = (project in file("rdf-protos"))
     publishArtifact := false,
   )
 
+lazy val generateProtos = taskKey[Seq[File]]("Copies and modifies proto files before compilation")
+
+// Intermediate project that generates the Scala code from the protobuf files
+lazy val rdfProtosJava = (project in file("rdf-protos-java"))
+  .enablePlugins(ProtobufPlugin)
+  .settings(
+    name := "jelly-protos-java",
+    organization := "eu.neverblink.jelly",
+    libraryDependencies ++= Seq(
+      "com.google.protobuf" % "protobuf-java" % protobufV,
+    ),
+    generateProtos := {
+      val inputDir = (baseDirectory.value / ".." / "submodules" / "protobuf" / "proto").getAbsoluteFile
+      val outputDir = (baseDirectory.value / "src" / "main" / "protobuf").getAbsoluteFile
+
+      // Make output dir if not exists
+      IO.createDirectory(outputDir)
+
+      // Clean the output directory
+      IO.delete(IO.listFiles(outputDir))
+
+      val protoFiles = (inputDir ** "*.proto").get
+      protoFiles
+        .map { file =>
+          // Copy the file to the output directory
+          val outputFile = outputDir / file.relativeTo(inputDir).get.getPath
+          IO.copyFile(file, outputFile)
+          outputFile
+        }
+        .map { file =>
+          // Append java options to the file
+          val content = IO.read(file)
+          val newContent = content +
+            """
+              |option java_multiple_files = true;
+              |option java_package = "eu.neverblink.jelly.core.proto.v1";
+              |option optimize_for = SPEED;
+              |""".stripMargin
+          IO.write(file, newContent)
+          file
+        }
+
+      // Return the list of generated files
+      protoFiles.map { file =>
+        val outputFile = outputDir / file.relativeTo(inputDir).get.getPath
+        outputFile
+      }
+    },
+    Compile / compile := (Compile / compile).dependsOn(generateProtos).value,
+    ProtobufConfig / protobufExcludeFilters := Seq(Glob(baseDirectory.value.toPath) / "**" / "grpc.proto"),
+    publishArtifact := false,
+  )
+
 lazy val core = (project in file("core"))
   .settings(
     name := "jelly-core",
@@ -103,9 +158,33 @@ lazy val core = (project in file("core"))
     commonSettings,
   )
 
+lazy val coreJava = (project in file("core-java"))
+  .settings(
+    name := "jelly-core-java",
+    description := "Core code for serializing and deserializing RDF data in the Jelly format. Java edition.",
+    libraryDependencies ++= Seq(
+      "com.google.protobuf" % "protobuf-java" % protobufV,
+    ),
+    Compile / sourceGenerators += Def.task {
+      // Copy from the managed source directory to the output directory
+      val inputDir = (rdfProtosJava / target).value / ("scala-" + scalaVersion.value) / "src_managed" / "main"
+      val outputDir = sourceManaged.value / "main" / "protobuf"
+      val javaFiles = (inputDir ** "*.java").get
+      javaFiles.map { file =>
+        val outputFile = outputDir / file.relativeTo(inputDir).get.getPath
+        IO.copyFile(file, outputFile)
+        outputFile
+      }
+
+    }.dependsOn(rdfProtosJava / Compile / compile),
+    Compile / sourceManaged := sourceManaged.value / "main",
+    commonSettings,
+  )
+
 lazy val corePatch = (project in file("core-patch"))
   .settings(
     name := "jelly-core-patch",
+    organization := "eu.neverblink.jelly",
     description := "Core code for the RDF Patch Jelly extension.",
     // Add the generated proto classes after transforming them with Scalameta
     Compile / sourceGenerators += Def.task {

core-java/src/main/java/eu/neverblink/jelly/core/JellyConstants.java

@@ -0,0 +1,19 @@
+package eu.neverblink.jelly.core;
+
+public class JellyConstants {
+
+    private JellyConstants() {}
+
+    public static final String JELLY_NAME = "Jelly";
+    public static final String JELLY_FILE_EXTENSION = "jelly";
+    public static final String JELLY_CONTENT_TYPE = "application/x-jelly-rdf";
+
+    public static final int PROTO_VERSION_1_0_X = 1;
+    public static final int PROTO_VERSION_1_1_X = 2;
+    public static final int PROTO_VERSION = PROTO_VERSION_1_1_X;
+
+    public static final String PROTO_SEMANTIC_VERSION_1_0_0 = "1.0.0"; // First protocol version
+    public static final String PROTO_SEMANTIC_VERSION_1_1_0 = "1.1.0"; // Protocol version with namespace declarations
+    public static final String PROTO_SEMANTIC_VERSION_1_1_1 = "1.1.1"; // Protocol version with metadata in RdfStreamFrame
+    public static final String PROTO_SEMANTIC_VERSION = PROTO_SEMANTIC_VERSION_1_1_1;
+}

core-java/src/main/java/eu/neverblink/jelly/core/JellyConverterFactory.java

@@ -0,0 +1,120 @@
+package eu.neverblink.jelly.core;
+
+import eu.neverblink.jelly.core.internal.ProtoDecoderImpl;
+import eu.neverblink.jelly.core.internal.ProtoEncoderImpl;
+import eu.neverblink.jelly.core.proto.v1.RdfStreamOptions;
+
+/**
+ * "Main" interface to be implemented by RDF conversion modules (e.g., for Jena and RDF4J).
+ * Exposes factory methods for building protobuf encoders and decoders.
+ * <p>
+ * This should typically be implemented as an object. You should also provide a package-scoped given for your
+ * implementation so that users can easily make use of the connector in the stream package.
+ *
+ * @param <TNode> Type of RDF nodes in the RDF library
+ * @param <TDatatype> Type of RDF datatypes in the RDF library
+ * @param <TEncoderConverter> Implementation of ProtoEncoderConverter for a given RDF library.
+ * @param <TDecoderConverter> Implementation of ProtoDecoderConverter for a given RDF library.
+ */
+public abstract class JellyConverterFactory<
+    TNode,
+    TDatatype,
+    TEncoderConverter extends ProtoEncoderConverter<TNode>,
+    TDecoderConverter extends ProtoDecoderConverter<TNode, TDatatype>
+> {
+
+    /**
+     * To be implemented by subclasses. Returns an instance of ProtoEncoderConverter for the RDF library.
+     */
+    protected abstract TEncoderConverter encoderConverter();
+
+    /**
+     * To be implemented by subclasses. Returns an instance of ProtoDecoderConverter for the RDF library.
+     */
+    protected abstract TDecoderConverter decoderConverter();
+
+    /**
+     * Create a new ProtoEncoder.
+     * @param params Parameters for the encoder.
+     * @return encoder
+     */
+    public final ProtoEncoder<TNode> encoder(ProtoEncoder.Params params) {
+        return new ProtoEncoderImpl<>(encoderConverter(), params);
+    }
+
+    /**
+     * Create a new TriplesDecoder.
+     * @param supportedOptions maximum supported options for the decoder. If not provided, this.defaultSupportedOptions
+     *                         will be used. If you want to modify this (e.g., to specify an expected logical stream
+     *                         type), you should always use this.defaultSupportedOptions.withXxx.
+     *                         namespace prefix (without a colon), the second is the IRI node.
+     * @param tripleHandler the handler to use for decoding triples
+     * @return decoder
+     */
+    public final ProtoDecoder<TNode, TDatatype> triplesDecoder(
+        RdfHandler.TripleHandler<TNode> tripleHandler,
+        RdfStreamOptions supportedOptions
+    ) {
+        return new ProtoDecoderImpl.TriplesDecoder<>(decoderConverter(), tripleHandler, supportedOptions);
+    }
+
+    /**
+     * Create a new QuadsDecoder.
+     * @param supportedOptions maximum supported options for the decoder. If not provided, this.defaultSupportedOptions
+     *                         will be used. If you want to modify this (e.g., to specify an expected logical stream
+     *                         type), you should always use this.defaultSupportedOptions.toBuilder().setXxx.build();.
+     * @param quadHandler the handler to use for decoding quads
+     * @return decoder
+     */
+    public final ProtoDecoder<TNode, TDatatype> quadsDecoder(
+        RdfHandler.QuadHandler<TNode> quadHandler,
+        RdfStreamOptions supportedOptions
+    ) {
+        return new ProtoDecoderImpl.QuadsDecoder<>(decoderConverter(), quadHandler, supportedOptions);
+    }
+
+    /**
+     * Create a new GraphsAsQuadsDecoder.
+     * @param supportedOptions maximum supported options for the decoder. If not provided, this.defaultSupportedOptions
+     *                         will be used. If you want to modify this (e.g., to specify an expected logical stream
+     *                         type), you should always use this.defaultSupportedOptions.toBuilder().setXxx.build();.
+     * @param graphHandler the handler to use for decoding graphs
+     * @return decoder
+     */
+    public final ProtoDecoder<TNode, TDatatype> graphsAsQuadsDecoder(
+        RdfHandler.QuadHandler<TNode> graphHandler,
+        RdfStreamOptions supportedOptions
+    ) {
+        return new ProtoDecoderImpl.GraphsAsQuadsDecoder<>(decoderConverter(), graphHandler, supportedOptions);
+    }
+
+    /**
+     * Create a new GraphsDecoder.
+     * @param supportedOptions maximum supported options for the decoder. If not provided, this.defaultSupportedOptions
+     *                         will be used. If you want to modify this (e.g., to specify an expected logical stream
+     *                         type), you should always use this.defaultSupportedOptions.toBuilder().setXxx.build();.
+     * @param graphHandler the handler to use for decoding graphs
+     * @return decoder
+     */
+    public final ProtoDecoder<TNode, TDatatype> graphsDecoder(
+        RdfHandler.GraphHandler<TNode> graphHandler,
+        RdfStreamOptions supportedOptions
+    ) {
+        return new ProtoDecoderImpl.GraphsDecoder<>(decoderConverter(), graphHandler, supportedOptions);
+    }
+
+    /**
+     * Create a new AnyStatementDecoder.
+     * @param supportedOptions maximum supported options for the decoder. If not provided, this.defaultSupportedOptions
+     *                         will be used. If you want to modify this (e.g., to specify an expected logical stream
+     *                         type), you should always use this.defaultSupportedOptions.toBuilder().setXxx.build();.
+     * @param anyStatementHandler the handler to use for decoding any statements
+     * @return decoder
+     */
+    public final ProtoDecoder<TNode, TDatatype> anyStatementDecoder(
+        RdfHandler.AnyStatementHandler<TNode> anyStatementHandler,
+        RdfStreamOptions supportedOptions
+    ) {
+        return new ProtoDecoderImpl.AnyStatementDecoder<>(decoderConverter(), anyStatementHandler, supportedOptions);
+    }
+}