Package no.hasmac.jsonld
Class JsonLdOptions
java.lang.Object
no.hasmac.jsonld.JsonLdOptions
The
JsonLdOptions
type is used to pass various options to the processor.- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate URI
The base IRI to use when expanding or compacting the document.private boolean
If set to true, the JSON-LD processor replaces arrays with just one element with that element during compaction.private boolean
Determines if IRIs are compacted relative to the base option or document location when compacting.static final boolean
static final boolean
static final boolean
private DocumentLoader
The callback of the loader to be used to retrieve remote documents and contexts, implementing the LoadDocumentCallback.private JsonLdEmbed
private boolean
private Document
A context that is used to initialize the active context when expanding a document.private boolean
private boolean
private boolean
private boolean
private Boolean
private boolean
private JsonLdVersion
private boolean
private JsonLdOptions.RdfDirection
private boolean
private boolean
private boolean
private boolean
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetBase()
The base IRI to use when expanding or compacting the document.The callback of the loader to be used to retrieve remote documents and contexts, implementing theDocumentLoader
.getEmbed()
boolean
If set totrue
, the processor replaces arrays with just one element with that element during compaction.boolean
Determines if IRIs are compacted relative to thegetBase()
option or document location when compacting.boolean
If enabled, warnings are thrown as exceptions and not just logged.boolean
boolean
If set totrue
, 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.boolean
Experimental: Numeric @id support state.boolean
boolean
If set totrue
, certain algorithm processing steps where indicated are ordered lexicographically.boolean
boolean
boolean
boolean
if disabled only URIs required for processing are parsed and validated.boolean
boolean
void
void
setCompactArrays
(boolean compactArrays) void
setCompactToRelative
(boolean compactToRelative) void
setContextCache
(Cache<String, jakarta.json.JsonValue> contextCache) void
setDocumentCache
(Cache<String, Document> documentCache) void
setDocumentLoader
(DocumentLoader documentLoader) void
setEmbed
(JsonLdEmbed embed) void
setExceptionOnWarning
(boolean exceptionOnWarning) If enabled, warnings are thrown as exceptions and not just logged.void
setExpandContext
(jakarta.json.JsonObject context) void
setExpandContext
(String contextLocation) void
setExpandContext
(URI contextUri) void
setExpandContext
(Document context) void
setExplicit
(boolean explicit) void
setExtractAllScripts
(boolean extractAllScripts) void
setNumericId
(boolean enable) Experimental: Enables/Disables numeric @id support.void
setOmitDefault
(boolean omitDefault) void
setOmitGraph
(Boolean omitGraph) void
setOrdered
(boolean ordered) void
setProcessingMode
(JsonLdVersion processingMode) void
setProduceGeneralizedRdf
(boolean produceGeneralizedRdf) void
setRdfDirection
(JsonLdOptions.RdfDirection rdfDirection) void
setRdfStar
(boolean rdfStar) Experimental: Enables JSON-LD-STAR extension.void
setRequiredAll
(boolean requiredAll) void
setUriValidation
(boolean enabled) if disabled only URIs required for processing are parsed and validated.void
setUseNativeTypes
(boolean useNativeTypes) void
setUseRdfType
(boolean useRdfType)
-
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
The base IRI to use when expanding or compacting the document. If set, this overrides the input document's IRI. -
compactArrays
private boolean compactArraysIf 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 compactToRelativeDetermines if IRIs are compacted relative to the base option or document location when compacting. -
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
A context that is used to initialize the active context when expanding a document. -
extractAllScripts
private boolean extractAllScripts -
ordered
private boolean ordered -
processingMode
-
produceGeneralizedRdf
private boolean produceGeneralizedRdf -
rdfDirection
-
useNativeTypes
private boolean useNativeTypes -
useRdfType
private boolean useRdfType -
embed
-
explicit
private boolean explicit -
omitDefault
private boolean omitDefault -
omitGraph
-
requiredAll
private boolean requiredAll -
rdfStar
private boolean rdfStar -
numericId
private boolean numericId -
contextCache
-
documentCache
-
uriValidation
private boolean uriValidation -
exceptionOnWarning
private boolean exceptionOnWarning
-
-
Constructor Details
-
JsonLdOptions
public JsonLdOptions() -
JsonLdOptions
-
JsonLdOptions
-
-
Method Details
-
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 totrue
, 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 thegetBase()
option or document location when compacting.- Returns:
true
if IRI relativization is enabled
-
getDocumentLoader
The callback of the loader to be used to retrieve remote documents and contexts, implementing theDocumentLoader
. 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 totrue
, 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 totrue
, certain algorithm processing steps where indicated are ordered lexicographically. Iffalse
, order is not considered in processing.- Returns:
true
if array sorting is enabled
-
getProcessingMode
-
isProduceGeneralizedRdf
public boolean isProduceGeneralizedRdf() -
getRdfDirection
-
isUseNativeTypes
public boolean isUseNativeTypes() -
isUseRdfType
public boolean isUseRdfType() -
getExpandContext
-
setBase
-
setCompactArrays
public void setCompactArrays(boolean compactArrays) -
setCompactToRelative
public void setCompactToRelative(boolean compactToRelative) -
setDocumentLoader
-
setExtractAllScripts
public void setExtractAllScripts(boolean extractAllScripts) -
setOrdered
public void setOrdered(boolean ordered) -
setProcessingMode
-
setProduceGeneralizedRdf
public void setProduceGeneralizedRdf(boolean produceGeneralizedRdf) -
setRdfDirection
-
setUseNativeTypes
public void setUseNativeTypes(boolean useNativeTypes) -
setUseRdfType
public void setUseRdfType(boolean useRdfType) -
setExpandContext
-
setExpandContext
-
setExpandContext
public void setExpandContext(jakarta.json.JsonObject context) -
setExpandContext
-
getEmbed
-
setEmbed
-
isExplicit
public boolean isExplicit() -
setExplicit
public void setExplicit(boolean explicit) -
isOmitDefault
public boolean isOmitDefault() -
setOmitDefault
public void setOmitDefault(boolean omitDefault) -
isOmitGraph
-
setOmitGraph
-
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
-
setContextCache
-
getDocumentCache
-
setDocumentCache
-
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
- settrue
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
- settrue
to throw warnings as exceptions
-