Module org.apache.jena.arq
Package 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 JsonLD10Writer) 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.

  • Constructor Details

    • JsonLDWriteContext

      public JsonLDWriteContext()

  • Method Details

    • 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).
      See Also:

    • 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.
      See Also:

    • 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": "https://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