Class JsonLdOptions

java.lang.Object
no.hasmac.jsonld.JsonLdOptions
public final class JsonLdOptions extends Object
The JsonLdOptions type is used to pass various options to the processor.
See Also:

  • Field Details

    • DEFAULT_RDF_STAR

      public static final boolean DEFAULT_RDF_STAR
      See Also:

    • DEFAULT_NUMERIC_ID

      public static final boolean DEFAULT_NUMERIC_ID
      See Also:

    • DEFAULT_URI_VALIDATION

      public static final boolean DEFAULT_URI_VALIDATION
      See Also:

    • base

      private URI base
      The base IRI to use when expanding or compacting the document. If set, this overrides the input document's IRI.

    • compactArrays

      private boolean compactArrays
      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.

    • compactToRelative

      private boolean compactToRelative
      Determines if IRIs are compacted relative to the base option or document location when compacting.

    • documentLoader

      private DocumentLoader documentLoader
      The callback of the loader to be used to retrieve remote documents and contexts, implementing the LoadDocumentCallback. If specified, it is used to retrieve remote documents and contexts; otherwise, if not specified, the processor's built-in loader is used.

    • expandContext

      private Document expandContext
      A context that is used to initialize the active context when expanding a document.

    • extractAllScripts

      private boolean extractAllScripts

    • ordered

      private boolean ordered

    • processingMode

      private JsonLdVersion processingMode

    • produceGeneralizedRdf

      private boolean produceGeneralizedRdf

    • rdfDirection

      private JsonLdOptions.RdfDirection rdfDirection

    • useNativeTypes

      private boolean useNativeTypes

    • useRdfType

      private boolean useRdfType

    • embed

      private JsonLdEmbed embed

    • explicit

      private boolean explicit

    • omitDefault

      private boolean omitDefault

    • omitGraph

      private Boolean omitGraph

    • requiredAll

      private boolean requiredAll

    • rdfStar

      private boolean rdfStar

    • numericId

      private boolean numericId

    • contextCache

      private Cache<String, jakarta.json.JsonValue> contextCache

    • documentCache

      private Cache<String,Document> documentCache

    • uriValidation

      private boolean uriValidation

    • exceptionOnWarning

      private boolean exceptionOnWarning

  • Constructor Details

    • JsonLdOptions

      public JsonLdOptions()

    • JsonLdOptions

      public JsonLdOptions(DocumentLoader loader)

    • JsonLdOptions

      public JsonLdOptions(JsonLdOptions options)

  • Method Details

    • getBase

      public URI getBase()
      The base IRI to use when expanding or compacting the document. If set, this overrides the input document's IRI.
      Returns:
      the base URI or null

    • isCompactArrays

      public boolean isCompactArrays()
      If set to true, the 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.
      Returns:
      true if array compaction is enabled

    • isCompactToRelative

      public boolean isCompactToRelative()
      Determines if IRIs are compacted relative to the getBase() option or document location when compacting.
      Returns:
      true if IRI relativization is enabled

    • getDocumentLoader

      public DocumentLoader getDocumentLoader()
      The callback of 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.
      Returns:
      the loader or null is is not set

    • isExtractAllScripts

      public boolean isExtractAllScripts()
      If set to true, when extracting JSON-LD script elements from HTML, unless a specific fragment identifier is targeted, extracts all encountered JSON-LD script elements using an array form, if necessary.
      Returns:
      true if script extraction is enabled

    • isOrdered

      public boolean isOrdered()
      If set to true, certain algorithm processing steps where indicated are ordered lexicographically. If false, order is not considered in processing.
      Returns:
      true if array sorting is enabled

    • getProcessingMode

      public JsonLdVersion getProcessingMode()

    • isProduceGeneralizedRdf

      public boolean isProduceGeneralizedRdf()

    • getRdfDirection

      public JsonLdOptions.RdfDirection getRdfDirection()

    • isUseNativeTypes

      public boolean isUseNativeTypes()

    • isUseRdfType

      public boolean isUseRdfType()

    • getExpandContext

      public Document getExpandContext()

    • setBase

      public void setBase(URI baseUri)

    • setCompactArrays

      public void setCompactArrays(boolean compactArrays)

    • setCompactToRelative

      public void setCompactToRelative(boolean compactToRelative)

    • setDocumentLoader

      public void setDocumentLoader(DocumentLoader documentLoader)

    • setExtractAllScripts

      public void setExtractAllScripts(boolean extractAllScripts)

    • setOrdered

      public void setOrdered(boolean ordered)

    • setProcessingMode

      public void setProcessingMode(JsonLdVersion processingMode)

    • setProduceGeneralizedRdf

      public void setProduceGeneralizedRdf(boolean produceGeneralizedRdf)

    • setRdfDirection

      public void setRdfDirection(JsonLdOptions.RdfDirection rdfDirection)

    • setUseNativeTypes

      public void setUseNativeTypes(boolean useNativeTypes)

    • setUseRdfType

      public void setUseRdfType(boolean useRdfType)

    • setExpandContext

      public void setExpandContext(String contextLocation)

    • setExpandContext

      public void setExpandContext(URI contextUri)

    • setExpandContext

      public void setExpandContext(jakarta.json.JsonObject context)

    • setExpandContext

      public void setExpandContext(Document context)

    • getEmbed

      public JsonLdEmbed getEmbed()

    • setEmbed

      public void setEmbed(JsonLdEmbed embed)

    • isExplicit

      public boolean isExplicit()

    • setExplicit

      public void setExplicit(boolean explicit)

    • isOmitDefault

      public boolean isOmitDefault()

    • setOmitDefault

      public void setOmitDefault(boolean omitDefault)

    • isOmitGraph

      public Boolean isOmitGraph()

    • setOmitGraph

      public void setOmitGraph(Boolean omitGraph)

    • isRequiredAll

      public boolean isRequiredAll()

    • setRequiredAll

      public void setRequiredAll(boolean requiredAll)

    • setNumericId

      public void setNumericId(boolean enable)
      Experimental: Enables/Disables numeric @id support.
      Parameters:
      enable - numeric @id support

    • isNumericId

      public boolean isNumericId()
      Experimental: Numeric @id support state. Disabled by default.
      Returns:
      true if numeric @id support is enabled

    • getContextCache

      public Cache<String, jakarta.json.JsonValue> getContextCache()

    • setContextCache

      public void setContextCache(Cache<String, jakarta.json.JsonValue> contextCache)

    • getDocumentCache

      public Cache<String,Document> getDocumentCache()

    • setDocumentCache

      public void setDocumentCache(Cache<String,Document> documentCache)

    • isRdfStar

      public boolean isRdfStar()

    • setRdfStar

      public void setRdfStar(boolean rdfStar)
      Experimental: Enables JSON-LD-STAR extension. Only expansion is supported. Disabled by default.
      See Also:

    • isUriValidation

      public boolean isUriValidation()
      if disabled only URIs required for processing are parsed and validated. Disabling URI validation might improve performance depending on the number of processed URIs.

      Warning: Disabled validation could cause an invalid output.

      Enabled by default.

      Returns:
      true if validation is enabled

    • setUriValidation

      public void setUriValidation(boolean enabled)
      if disabled only URIs required for processing are parsed and validated. Disabling URI validation might improve performance depending on the number of processed URIs.

      Warning: Disabled validation could cause an invalid output.

      Enabled by default.

      Parameters:
      enabled - set true to enable validation

    • isExceptionOnWarning

      public boolean isExceptionOnWarning()
      If enabled, warnings are thrown as exceptions and not just logged.

      Disabled by default.

      Returns:
      true if warnings are thrown as exceptions

    • setExceptionOnWarning

      public void setExceptionOnWarning(boolean exceptionOnWarning)
      If enabled, warnings are thrown as exceptions and not just logged.

      Disabled by default.

      Parameters:
      exceptionOnWarning - set true to throw warnings as exceptions