org.apache.jena.riot

Class JsonLDWriteContext

java.lang.Object

org.apache.jena.sparql.util.Context

org.apache.jena.riot.JsonLDWriteContext

public class JsonLDWriteContext
extends Context

Set of parameters that can be used to control the writing of JSON-LD. This class provides setters to define a "Context" suitable to be passed as last argument to WriterDatasetRIOT.write(OutputStream, DatasetGraph, PrefixMap, String, Context) when the WriterDatasetRIOT has been created with one of the JSON-LD RDFFormat variants (that is, when it is an instance of JsonLDWriter) Parameters that are actually useful depend on the JSON-LD output variant. None of them is required (default values being used), except for the "frame" one, when outputting using JSON-LD "frame" output variant.

Field Summary

Fields inherited from class org.apache.jena.sparql.util.Context

emptyContext

Constructor Summary

Constructors

Constructor and Description
JsonLDWriteContext()

Method Summary

Modifier and Type	Method and Description
void	setFrame(Object frame) Set the frame used in a "Frame" output
void	setFrame(String frame) Set the frame used in a "Frame" output
void	setJsonLDContext(Object jsonLdContext) Set the value of the JSON-LD "@context" node, used in "Compact" and "Flattened" JSON-LD outputs.
void	setJsonLDContext(String jsonLdContext) Set the value of the JSON-LD "@context" node, used in "Compact" and "Flattened" JSON-LD outputs.
void	setJsonLDContextSubstitution(String jsonLdContext) Allow to replace the content of the "@context" node with a given value.
void	setOptions(com.github.jsonldjava.core.JsonLdOptions opts) Set the JSON-LD java API's options If not set, a default value is used.

Methods inherited from class org.apache.jena.sparql.util.Context

copy, equals, get, get, getAsString, getAsString, getInt, getLong, hashCode, hasValue, hasValueAsString, hasValueAsString, isDefined, isFalse, isFalseOrUndef, isTrue, isTrueOrUndef, isUndef, keys, mergeCopy, put, putAll, remove, set, set, setCurrentDateTime, setFalse, setIfUndef, setTrue, setupContextForDataset, size, toString, unset

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonLDWriteContext

public JsonLDWriteContext()

Method Detail

setOptions

public void setOptions(com.github.jsonldjava.core.JsonLdOptions opts)

Set the JSON-LD java API's options If not set, a default value is used. (Note that this default is not the same as the one used by JSON-LD java API).

Parameters:

opts - the options as defined by the JSON-LD java API

setJsonLDContext

public void setJsonLDContext(String jsonLdContext)

Set the value of the JSON-LD "@context" node, used in "Compact" and "Flattened" JSON-LD outputs. Only useful for "Compact" and "Flattened" JSON-LD outputs, and not required: if not set, a value for the "@Context" node is computed, based on the content of the dataset and its prefix mappings.

Parameters:

jsonLdContext - the value of the "@context" node (a JSON value). Note that the use of an URI to pass an external context is not supported (as of JSONLD-java API 0.8.3)

See Also:

for a way to overcome this problem., setJsonLDContext(Object)

setJsonLDContext

public void setJsonLDContext(Object jsonLdContext)

Set the value of the JSON-LD "@context" node, used in "Compact" and "Flattened" JSON-LD outputs. Only useful for "Compact" and "Flattened" JSON-LD outputs, and not required: if not set, a value for the "@Context" node is computed, based on the content of the dataset and its prefix mappings.

Parameters:

jsonLdContext - the context as expected by JSON-LD java API. As of JSON-LD java 0.8.3, a Map defining the properties and the prefixes is OK. Note that the use an URI to pass an external context is not supported (JSONLD-java RDF 0.8.3)

See Also:

for a way to overcome this problem., setJsonLDContext(String)

setJsonLDContextSubstitution

public void setJsonLDContextSubstitution(String jsonLdContext)

Allow to replace the content of the "@context" node with a given value. This is useful, for instance, to allow to set the @content in the output to an URI, such as "@context": "http://schema.org/" Note that the actual content at this URI is NOT used when computing the output. The context used to compute the JSONLD output is the one normally used (as defined by a call to - or the lack of call to - setJsonLdContext) Only useful for "Compact" and "Flattened" JSON-LD outputs, and not required

Parameters:

jsonLdContext - the value of the "@context" node. Note the string is supposed to be a JSON Value: if passing an URI, the String must be quoted.

setFrame

public void setFrame(String frame)

Set the frame used in a "Frame" output

Parameters:

frame - the Json Object used as frame for the "frame" output

setFrame

public void setFrame(Object frame)

Set the frame used in a "Frame" output

Parameters:

frame - the frame Object expected by the JSON-LD java API