Class ToRdfApi

java.lang.Object
no.hasmac.jsonld.api.ToRdfApi
All Implemented Interfaces:
CommonApi<ToRdfApi>, ContextApi<ToRdfApi>, LoaderApi<ToRdfApi>
public final class ToRdfApi extends Object implements CommonApi<ToRdfApi>, LoaderApi<ToRdfApi>, ContextApi<ToRdfApi>

  • Field Details

    • document

      private final Document document

    • documentUri

      private final URI documentUri

    • options

      private JsonLdOptions options

  • Constructor Details

    • ToRdfApi

      public ToRdfApi(URI documentUri)

    • ToRdfApi

      public ToRdfApi(Document document)

  • Method Details

    • 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(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(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 -
      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 -
      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(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 -
      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 -
      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 -
      Returns:
      builder instance

    • get

      public RdfDataset get() throws JsonLdError
      Transform provided JSON-LD document into RdfDataset.
      Returns:
      RdfDataset representing provided JSON-LD document
      Throws:
      JsonLdError

    • get

      public <Triple, Quad, Iri extends Resource, Bnode extends Resource, Resource extends Value, Literal extends Value, Value> void get(RdfConsumer<Triple,Quad> rdfConsumer, RdfValueFactory<Triple,Quad,Iri,Bnode,Resource,Literal,Value> rdfValueFactory) throws JsonLdError
      Transform provided JSON-LD document into RdfDataset.
      Throws:
      JsonLdError

    • numericId

      public ToRdfApi numericId()
      Experimental: Accept numeric @id. Disabled by default.
      Returns:
      builder instance