Package com.apicatalog.jsonld.api

Class FromRdfApi

java.lang.Object

com.apicatalog.jsonld.api.FromRdfApi

All Implemented Interfaces:

CommonApi<FromRdfApi>, LoaderApi<FromRdfApi>

public final class FromRdfApi
extends Object
implements CommonApi<FromRdfApi>, LoaderApi<FromRdfApi>

Constructor Summary

Constructors

Constructor	Description
FromRdfApi(Document document)
FromRdfApi(URI documentUri)

Method Summary

Modifier and Type	Method	Description
FromRdfApi	base(URI baseUri)	Set the base IRI.
jakarta.json.JsonArray	get()	Get JSON-LD representation of the provided RdfDataset.
FromRdfApi	loader(DocumentLoader loader)	Set the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader.
FromRdfApi	mode(JsonLdVersion processingMode)	Set JSON-LD processing mode.
FromRdfApi	nativeTypes()
FromRdfApi	nativeTypes(boolean useNativeTypes)
FromRdfApi	options(JsonLdOptions options)	Override an existing settings with JsonLdOptions.
FromRdfApi	ordered(boolean enable)	If set to true, certain algorithm processing steps are ordered lexicographically.

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

Constructor Detail

FromRdfApi

public FromRdfApi(Document document)

FromRdfApi

public FromRdfApi(URI documentUri)

Method Detail

options

public FromRdfApi options(JsonLdOptions options)

Description copied from interface: CommonApi

Override an existing settings with JsonLdOptions.

Specified by:

options in interface CommonApi<FromRdfApi>

Parameters:

options - JsonLdOptions

Returns:

builder instance

mode

public FromRdfApi 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<FromRdfApi>

Parameters:

processingMode - to set

Returns:

builder instance

base

public FromRdfApi base(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<FromRdfApi>

Returns:

builder instance

ordered

public FromRdfApi 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<FromRdfApi>

Returns:

builder instance

loader

public FromRdfApi 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<FromRdfApi>

Returns:

builder instance

nativeTypes

public FromRdfApi nativeTypes()

nativeTypes

public FromRdfApi nativeTypes(boolean useNativeTypes)

get

public jakarta.json.JsonArray get()
                           throws JsonLdError

Get JSON-LD representation of the provided RdfDataset.

Returns:

JsonArray representing JSON-LD document

Throws:

JsonLdError