Skip to content

HASMAC-AS/hasmac-json-ld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HASMAC JSON-LD 1.1 Processor & API

HASMAC JSON-LD is a fast and efficient JSON-LD 1.1 implementation based off of Titanium JSON-LD.

  • Maven Central License

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%
RDF to JSON-LD 51 51 100%
Framing 89 88 98.8%
Remote Document and Context Retrieval 18 17 94.4%

Extensions

Usage

Maven

Java 11 or higher

<dependency>
  <groupId>no.hasmac</groupId>
  <artifactId>hasmac-json-ld</artifactId>
  <version>0.10.0</version>
</dependency>

Documentation

javadoc

Examples

HASMAC JSON-LD 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.

Java 11

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

Java 8

> cd hasmac-json-ld
> ./mvnw -f pom_jre8.xml clean package

Resources

Commercial Support

Commercial support is available at [email protected]