README.md

Titanium JSON-LD 1.1 Processor & API

An implementation of the JSON-LD 1.1 (JSON-based Serialization for Linked Data) specification in Java utilizing Jakarta JSON Processing.

The goals of Titanium are:

• conformance to the specification
• secure, stable, fast, A+ code
• minimal external dependencies
  • only jakarta.json-api is required
• simple to use

Table of Contents

• Conformance
• CLI
• Extensions
• Usage
  • Installation
  • Documentation
  • Examples
• Contributing
• Resources
• Commercial Support

Conformance

The goal is to pass the official test suite and conform to the JSON-LD 1.1 specification.

Status

Feature	Tests	Pass	Status	Notes
Expansion	371	371	100%
Compaction	242	242	100%
Flattening	55	55	100%
JSON-LD to RDF	451	449	99.5%	te075 - @vocab as blank node identifier tli12 - List with bad @base
RDF to JSON-LD	51	51	100%
Framing	89	88	98.8%	t0059 - @embed: @last
Remote Document and Context Retrieval	18	17	94.4%	t0013 - HTML document

See EARL results from the JSON-LD 1.1 Test Suite for more details.

CLI

JSON-LD-CLI is a native command line utility for Ubuntu, Mac, Windows

Extensions

• JSON-LD-star expansion and compaction built-in support (experimental)
• Universal RDF Dataset Normalization Algorithm - URDNA2015

Usage

Installation

Titanium

Maven

<dependency>
    <groupId>com.apicatalog</groupId>
    <artifactId>titanium-json-ld</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle

compile group: 'com.apicatalog', name: 'titanium-json-ld', version: '1.3.0'

JSON-P Provider

Add JSON-P provider, if it is not on the classpath already.

Maven

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>jakarta.json</artifactId>
    <version>2.0.1</version>
</dependency>

Gradle

compile group: 'org.glassfish', name: 'jakarta.json', version: '2.0.1'

Documentation

Examples

Titanium provides high-level JsonLd API to interact with the processor.

// Expansion
JsonLd.expand("https://w3c.github.io/json-ld-api/tests/expand/0001-in.jsonld")
      .ordered()
      .get();

JsonLd.expand("file:/home/filip/document.json")    // HTTP(S) and File schemes supported
      .context("file:/home/filip/context.jsonld")  // external context
      .get();

// Compaction
JsonLd.compact("https://example/expanded.jsonld", "https://example/context.jsonld")
      .compactToRelative(false)
      .get();

// Flattening
JsonLd.flatten("https://example/document.jsonld").get();

// JSON-LD to RDF
JsonLd.toRdf("https://example/document.jsonld").get();

// RDF to JSON-LD
JsonLd.fromRdf("https://example/document.nq").options(options).get();

// Framing
JsonLd.frame("https://example/document.jsonld", "https://example/frame.jsonld").get();

// Local document
Document document = JsonDocument.of(InputStream) or JsonDocument.of(Reader) ...

JsonLd.expand(document).get();

JsonLd.compact(document, contextDocument).get();
...

Contributing

All PR's welcome!

• develop
  • implement a new feature
  • fix an existing issue
  • improve an existing implementation
• test
  • report a bug
  • implement a test case
• document
  • write javadoc
  • write a tutorial
  • proofread an existing documentation
• promote
  • star, share, the project
  • write an article
• sponsor
  • your requests get top priority
  • you will get a badge

Building

Fork and clone the project repository.

> cd titanium-json-ld
> ./mvnw clean package

Resources

• JSON-LD 1.1
• JSON-LD 1.1 Processing Algorithms and API
• JSON-LD 1.1 Framing
• JSON-LD Best Practices
• JSON-LD-star
• JSON-LD Playground

Commercial Support

Commercial support is available at [email protected]