Package org.eclipse.rdf4j.rio.helpers

Class JSONLDSettings

java.lang.Object

org.eclipse.rdf4j.rio.helpers.JSONLDSettings

public class JSONLDSettings
extends Object

Settings that can be passed to JSONLD Parsers and Writers.

Author:

Peter Ansell

See Also:

• JSONLD Data Structures

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanRioSetting	COMPACT_ARRAYS	If set to true, the JSON-LD processor replaces arrays with just one element with that element during compaction.
static final RioSetting<com.github.jsonldjava.core.DocumentLoader>	DOCUMENT_LOADER	If specified, it is used to retrieve remote documents and contexts; otherwise the processor's built-in loader is used.
static final BooleanRioSetting	DOCUMENT_LOADER_CACHE	The document loader cache is enabled by default.
static final BooleanRioSetting	EXCEPTION_ON_WARNING	The JSON-LD processor will throw an exception if a warning is encountered during processing.
static final RioSetting<no.hasmac.jsonld.document.Document>	EXPAND_CONTEXT	The JSON-LD context to use when expanding JSON-LD
static final RioSetting<no.hasmac.jsonld.document.Document>	FRAME
static final BooleanRioSetting	HIERARCHICAL_VIEW	If set to true, the JSON-LD processor will try to represent the JSON-LD object in a hierarchical view.
static final RioSetting<JSONLDMode>	JSONLD_MODE	The JSONLDMode that the writer will use to reorganise the JSONLD document after it is created.
static final BooleanRioSetting	OPTIMIZE	If set to true, the JSON-LD processor is allowed to optimize the output of the Compaction algorithm to produce even compacter representations.
static final BooleanRioSetting	PRODUCE_GENERALIZED_RDF	If set to true, the JSON-LD processor may emit blank nodes for triple predicates, otherwise they will be omitted.
static final BooleanRioSetting	SECURE_MODE	Secure mode only allows loading remote/local resources (ex.
static final BooleanRioSetting	USE_NATIVE_TYPES	If set to true, the JSON-LD processor will try to convert typed values to JSON native types instead of using the expanded object form when converting from RDF.
static final BooleanRioSetting	USE_RDF_TYPE	If set to true, the JSON-LD processor will use the expanded rdf:type IRI as the property instead of @type when converting from RDF.
static final SetRioSetting<String>	WHITELIST	Whitelist of remote/local resources that the JSON-LD parser can retrieve.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

COMPACT_ARRAYS

public static final BooleanRioSetting COMPACT_ARRAYS

If set to true, the JSON-LD processor replaces arrays with just one element with that element during compaction. If set to false, all arrays will remain arrays even if they have just one element.

Defaults to true.

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.compact_arrays.

See Also:

• JSONLD Data Structures

DOCUMENT_LOADER

public static final RioSetting<com.github.jsonldjava.core.DocumentLoader> DOCUMENT_LOADER

If specified, it is used to retrieve remote documents and contexts; otherwise the processor's built-in loader is used.

EXPAND_CONTEXT

public static final RioSetting<no.hasmac.jsonld.document.Document> EXPAND_CONTEXT

The JSON-LD context to use when expanding JSON-LD

See Also:

• https://www.w3.org/TR/json-ld11-api/#dom-jsonldoptions-expandcontext.

FRAME

public static final RioSetting<no.hasmac.jsonld.document.Document> FRAME

EXCEPTION_ON_WARNING

public static final BooleanRioSetting EXCEPTION_ON_WARNING

The JSON-LD processor will throw an exception if a warning is encountered during processing.

OPTIMIZE

public static final BooleanRioSetting OPTIMIZE

If set to true, the JSON-LD processor is allowed to optimize the output of the Compaction algorithm to produce even compacter representations.

Defaults to false.

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.optimize.

See Also:

• JSONLD Data Structures

PRODUCE_GENERALIZED_RDF

public static final BooleanRioSetting PRODUCE_GENERALIZED_RDF

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

Note: the use of blank node identifiers to label properties is obsolete, and may be removed in a future version of JSON-LD,

Defaults to false.

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.produce_generalized_rdf.

See Also:

• JSONLD Data Structures

USE_NATIVE_TYPES

public static final BooleanRioSetting USE_NATIVE_TYPES

If set to true, the JSON-LD processor will try to convert typed values to JSON native types instead of using the expanded object form when converting from RDF. xsd:boolean values will be converted to true or false. xsd:integer and xsd:double values will be converted to JSON numbers.

Defaults to false for RDF compatibility.

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.use_native_types.

See Also:

• JSONLD Data Structures

USE_RDF_TYPE

public static final BooleanRioSetting USE_RDF_TYPE

If set to true, the JSON-LD processor will use the expanded rdf:type IRI as the property instead of @type when converting from RDF.

Defaults to false.

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.use_rdf_type.

See Also:

• JSONLD Data Structures

JSONLD_MODE

public static final RioSetting<JSONLDMode> JSONLD_MODE

The JSONLDMode that the writer will use to reorganise the JSONLD document after it is created.

Defaults to JSONLDMode.EXPAND to provide maximum RDF compatibility.

See Also:

• JSONLD Features

HIERARCHICAL_VIEW

public static final BooleanRioSetting HIERARCHICAL_VIEW

If set to true, the JSON-LD processor will try to represent the JSON-LD object in a hierarchical view.

Default to false

Can be overridden by setting system property org.eclipse.rdf4j.rio.jsonld.hierarchical_view.

WHITELIST

public static final SetRioSetting<String> WHITELIST

Whitelist of remote/local resources that the JSON-LD parser can retrieve. Set of URIs as strings. This can be overridden by setting a system property with the key org.eclipse.rdf4j.rio.jsonld_whitelist and a JSON array of the desired values.

Default:

invalid @code

{@code Set.of("http://www.w3.org/ns/anno.jsonld", "http://www.w3.org/ns/activitystreams.jsonld", "http://www.w3.org/ns/ldp.jsonld", "http://www.w3.org/ns/oa.jsonld", "http://www.w3.org/ns/hydra/context.jsonld", "http://schema.org/", "https://w3id.org/security/v1", "https://w3c.github.io/json-ld-rc/context.jsonld", "https://www.w3.org/2018/credentials/v1", "https://health-lifesci.schema.org/", "https://auto.schema.org/", "https://bib.schema.org/", "http://xmlns.com/foaf/spec/index.jsonld", "https://pending.schema.org/", "https://schema.org/", "https://schema.org/docs/jsonldcontext.jsonld", "https://schema.org/version/latest/schemaorg-current-https.jsonld", "https://schema.org/version/latest/schemaorg-all-http.jsonld", "https://schema.org/version/latest/schemaorg-all-https.jsonld", "https://schema.org/version/latest/schemaorg-current-http.jsonld", "https://schema.org/version/latest/schemaorg-all.jsonld", "https://schema.org/version/latest/schemaorg-current.jsonld", "https://project-open-data.cio.gov/v1.1/schema/catalog.jsonld", "https://geojson.org/geojson-ld/geojson-context.jsonld", "https://www.w3.org/2019/wot/td/v1");

SECURE_MODE

public static final BooleanRioSetting SECURE_MODE

Secure mode only allows loading remote/local resources (ex. context from url) that are whitelisted. This can be overridden by setting a system property with the key org.eclipse.rdf4j.rio.jsonld_secure_mode and a boolean value.

Default: true

DOCUMENT_LOADER_CACHE

public static final BooleanRioSetting DOCUMENT_LOADER_CACHE

The document loader cache is enabled by default. All loaded documents, such as remote contexts, are cached for 1 hour, or until the cache is full. The cache holds up to 1000 documents. The cache is shared between all JSONLDParsers. The cache can be disabled by setting this value to false.

Default: true