Package com.apicatalog.jsonld

Class JsonLdOptions

java.lang.Object

com.apicatalog.jsonld.JsonLdOptions

public final class JsonLdOptions
extends Object

The JsonLdOptions type is used to pass various options to the processor.

See Also:

The JsonLdOptions Specification.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonLdOptions.RdfDirection

Constructor Summary

Constructors

Constructor	Description
JsonLdOptions()
JsonLdOptions(JsonLdOptions options)
JsonLdOptions(DocumentLoader loader)

Method Summary

Modifier and Type	Method	Description
URI	getBase()	The base IRI to use when expanding or compacting the document.
Cache<String,jakarta.json.JsonValue>	getContextCache()
Cache<String,Document>	getDocumentCache()
DocumentLoader	getDocumentLoader()	The callback of the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader.
JsonLdEmbed	getEmbed()
Document	getExpandContext()
JsonLdVersion	getProcessingMode()
JsonLdOptions.RdfDirection	getRdfDirection()
boolean	isCompactArrays()	If set to true, the processor replaces arrays with just one element with that element during compaction.
boolean	isCompactToRelative()	Determines if IRIs are compacted relative to the getBase() option or document location when compacting.
boolean	isExplicit()
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.
boolean	isNumericId()	Experimental: Numeric @id support state.
boolean	isOmitDefault()
Boolean	isOmitGraph()
boolean	isOrdered()	If set to true, certain algorithm processing steps where indicated are ordered lexicographically.
boolean	isProduceGeneralizedRdf()
boolean	isRdfStar()
boolean	isRequiredAll()
boolean	isUseNativeTypes()
boolean	isUseRdfType()
void	setBase(URI baseUri)
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	setExpandContext(Document context)
void	setExpandContext(jakarta.json.JsonObject context)
void	setExpandContext(String contextLocation)
void	setExpandContext(URI contextUri)
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	setUseNativeTypes(boolean useNativeTypes)
void	setUseRdfType(boolean useRdfType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonLdOptions

public JsonLdOptions()

JsonLdOptions

public JsonLdOptions(DocumentLoader loader)

JsonLdOptions

public JsonLdOptions(JsonLdOptions options)

Method Detail

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:

JSON-LD-STAR Draft