Package com.apicatalog.jsonld.api

Class ToRdfApi

java.lang.Object

com.apicatalog.jsonld.api.ToRdfApi

All Implemented Interfaces:

CommonApi<ToRdfApi>, ContextApi<ToRdfApi>, LoaderApi<ToRdfApi>

public final class ToRdfApi
extends java.lang.Object
implements CommonApi<ToRdfApi>, LoaderApi<ToRdfApi>, ContextApi<ToRdfApi>

Field Summary

Fields

Modifier and Type	Field	Description
private Document	document
private java.net.URI	documentUri
private JsonLdOptions	options

Constructor Summary

Constructors

Constructor	Description
ToRdfApi(Document document)
ToRdfApi(java.net.URI documentUri)

Method Summary

Modifier and Type	Method	Description
ToRdfApi	base(java.net.URI baseUri)	Set the base IRI.
ToRdfApi	context(Document context)	A context that is used to initialize the active context.
ToRdfApi	context(jakarta.json.JsonStructure context)	A context that is used to initialize the active context.
ToRdfApi	context(java.lang.String contextLocation)	A context that is used to initialize the active context.
ToRdfApi	context(java.net.URI contextUri)	A context that is used to initialize the active context.
RdfDataset	get()	Deprecated. since 1.7.0 - Use provide(RdfQuadConsumer) instead.
ToRdfApi	loader(DocumentLoader loader)	Set the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader.
ToRdfApi	mode(JsonLdVersion processingMode)	Set JSON-LD processing mode.
ToRdfApi	numericId()	Experimental: Accept numeric @id.
ToRdfApi	options(JsonLdOptions options)	Override an existing settings with JsonLdOptions.
ToRdfApi	ordered(boolean enable)	If set to true, certain algorithm processing steps are ordered lexicographically.
ToRdfApi	produceGeneralizedRdf()	The JSON-LD processor may emit blank nodes for triple predicates.
ToRdfApi	produceGeneralizedRdf(boolean enable)	If set to true, the JSON-LD processor may emit blank nodes for triple predicates, otherwise they will be omitted.
void	provide(com.apicatalog.rdf.api.RdfQuadConsumer consumer)	Emit transformed JSON-LD as RDF quads.
ToRdfApi	rdfDirection(JsonLdOptions.RdfDirection direction)	Determines how value objects containing a base direction are transformed to and from RDF.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.apicatalog.jsonld.api.CommonApi

base, ordered

Field Detail

document

private final Document document

documentUri

private final java.net.URI documentUri

options

private JsonLdOptions options

Constructor Detail

ToRdfApi

public ToRdfApi(java.net.URI documentUri)

ToRdfApi

public ToRdfApi(Document document)

Method Detail

options

public ToRdfApi options(JsonLdOptions options)

Description copied from interface: CommonApi

Override an existing settings with JsonLdOptions.

Specified by:

options in interface CommonApi<ToRdfApi>

Parameters:

options - JsonLdOptions

Returns:

builder instance

context

public ToRdfApi context(java.net.URI contextUri)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ToRdfApi>

Parameters:

contextUri - URI referring to a context

Returns:

builder instance

context

public ToRdfApi context(java.lang.String contextLocation)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ToRdfApi>

Parameters:

contextLocation - IRI referring to a context

Returns:

builder instance

context

public ToRdfApi context(jakarta.json.JsonStructure context)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ToRdfApi>

Parameters:

context - JsonObject, a sequence of JsonObject, or a JsonString representing an IRI

Returns:

builder instance

context

public ToRdfApi context(Document context)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ToRdfApi>

Parameters:

context - Document representing a context

Returns:

builder instance

produceGeneralizedRdf

public ToRdfApi produceGeneralizedRdf(boolean enable)

If set to true, the JSON-LD processor may emit blank nodes for triple predicates, otherwise they will be omitted.

Parameters:

enable - true to produce generalized RDF

Returns:

builder instance

produceGeneralizedRdf

public ToRdfApi produceGeneralizedRdf()

The JSON-LD processor may emit blank nodes for triple predicates.

Returns:

builder instance

rdfDirection

public ToRdfApi rdfDirection(JsonLdOptions.RdfDirection direction)

Determines how value objects containing a base direction are transformed to and from RDF.

Parameters:

direction - determines how to process directed language-tagged literals

Returns:

builder instance

mode

public ToRdfApi mode(JsonLdVersion processingMode)

Description copied from interface: CommonApi

Set JSON-LD processing mode. JSON-LD 1.1 is set by default.

Specified by:

mode in interface CommonApi<ToRdfApi>

Parameters:

processingMode - to set

Returns:

builder instance

base

public ToRdfApi base(java.net.URI baseUri)

Description copied from interface: CommonApi

Set the base IRI. If set, this overrides the input document's IRI.

Specified by:

base in interface CommonApi<ToRdfApi>

Parameters:

baseUri - the base IRI, or null.

Returns:

builder instance

loader

public ToRdfApi loader(DocumentLoader loader)

Description copied from interface: LoaderApi

Set the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader. If specified, it is used to retrieve remote documents and contexts; otherwise, if not specified, the processor's built-in loader is used.

Specified by:

loader in interface LoaderApi<ToRdfApi>

Parameters:

loader - the DocumentLoader instance, never null.

Returns:

builder instance

ordered

public ToRdfApi ordered(boolean enable)

Description copied from interface: CommonApi

If set to true, certain algorithm processing steps are ordered lexicographically. If false, order is not considered in processing.

Specified by:

ordered in interface CommonApi<ToRdfApi>

Parameters:

enable - true to enable ordered result

Returns:

builder instance

get

@Deprecated
public RdfDataset get()
               throws JsonLdError

Deprecated.

since 1.7.0 - Use provide(RdfQuadConsumer) instead.

Transforms the provided JSON-LD document into an RdfDataset.

This method converts a JSON-LD document into an RDF dataset representation. It has been deprecated in favor of provide(RdfQuadConsumer).

Returns:

an RdfDataset representing the provided JSON-LD document

Throws:

JsonLdError - if the transformation fails

provide

public void provide(com.apicatalog.rdf.api.RdfQuadConsumer consumer)
             throws JsonLdError

Emit transformed JSON-LD as RDF quads.

Note: toRdf() method adopts the RdfQuadConsumer interface, allowing integration with Jena, Jelly, RDF4J, and other RDF libraries.

Parameters:

consumer - that accepts emitted RDF statements

Throws:

JsonLdError - if the document transformation fails

Since:

1.6.0

numericId

public ToRdfApi numericId()

Experimental: Accept numeric @id. Disabled by default.

Returns:

builder instance