Scala

Generate Scala classes, one file per class, enum and type.

Usage

CLI

ohi get w3c/prov-o
ohi linkml to scala --package org.example.prov \
  --to src/org/example/prov/ prov-o.linkml.yaml

Python

import ohi_linkml

with ohi_linkml.load_file("prov-o.linkml.yaml") as schema:
    files = schema.scala(package="org.example.prov")

JavaScript

import { readFileSync } from "node:fs";
import { LinkML } from "@neverblink/linkml";

const yaml = readFileSync("prov-o.linkml.yaml", "utf8");
const { view, report } = LinkML.loadFromString(yaml, {});
if (!view) throw new Error(JSON.stringify(report));
const files = view.scala({ package: "org.example.prov" });

Scala

import eu.neverblink.linkml.generator.options.ScalaGeneratorOptions
import eu.neverblink.linkml.generator.scala.ScalaGenerator
import eu.neverblink.linkml.schemaview.{SchemaIssues, SchemaView}

val loaded = SchemaView.loadSchemaViewFromUri("prov-o.linkml.yaml")
given SchemaView = SchemaIssues.orThrow(loaded)
val files = ScalaGenerator().generate(
  ScalaGeneratorOptions(`package` = "org.example.prov"),
)

C

#include <stddef.h>
#include "ohi_linkml.h"

linkml_init_threads();
char *report = NULL, *error = NULL;
long long schema =
    linkml_load_file("prov-o.linkml.yaml", NULL, &report, &error);
char *files = linkml_scala(
    schema,
    "{\"package\": \"org.example.prov\"}",
    &error
);
linkml_free(files);
linkml_free(report);
linkml_free(error);
linkml_close(schema);

Try it in the playground, with PROV-O

Options

error_handlingScalaErrorHandlingdefault annotation

CLI --error-handlingScala errorHandling

How the functions of the schema report their errors.

• annotation Each error class gets an exception class, and the method is annotated with @throws for each of them.
• either The method returns Either[E1 | E2, R], with the error classes themselves on the left. No exception classes are generated. A function with no errors returns R as it is.

generate_emit_prefixesbooleandefault true

CLI --generate-emit-prefixesScala generateEmitPrefixes

Whether to generate a Prefixes object with the schema's emit_prefixes.

metadata_languagestringdefault en

CLI --metadata-languageScala metadataLanguage

The language of the titles and descriptions in the output, for schemas with text in more than one language.

packagestringdefault eu.neverblink.linkml.metamodel

CLI --packageScala `package`

The package of the generated classes.

skip_leaf_interfacesbooleandefault true

CLI --skip-leaf-interfacesScala skipLeafInterfaces

Whether a concrete class that no other class extends with is_a or mixins becomes one case class, instead of an interface and an ...Impl case class. Turn it off when other code has to extend the generated classes.