Package no.hasmac.jsonld.api
Class ExpansionApi
- java.lang.Object
-
- no.hasmac.jsonld.api.ExpansionApi
-
- All Implemented Interfaces:
CommonApi<ExpansionApi>
,ContextApi<ExpansionApi>
,LoaderApi<ExpansionApi>
public final class ExpansionApi extends java.lang.Object implements CommonApi<ExpansionApi>, LoaderApi<ExpansionApi>, ContextApi<ExpansionApi>
-
-
Field Summary
Fields Modifier and Type Field Description private Document
document
private java.net.URI
documentUri
private JsonLdOptions
options
-
Constructor Summary
Constructors Constructor Description ExpansionApi(java.net.URI documentUri)
ExpansionApi(Document document)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExpansionApi
base(java.net.URI baseUri)
Set the baseIRI
.ExpansionApi
context(jakarta.json.JsonStructure context)
A context that is used to initialize the active context.ExpansionApi
context(java.lang.String contextLocation)
A context that is used to initialize the active context.ExpansionApi
context(java.net.URI contextUri)
A context that is used to initialize the active context.ExpansionApi
context(Document context)
A context that is used to initialize the active context.jakarta.json.JsonArray
get()
Get the result of the document expansion.ExpansionApi
loader(DocumentLoader loader)
Set the loader to be used to retrieve remote documents and contexts, implementing theDocumentLoader
.ExpansionApi
mode(JsonLdVersion processingMode)
SetJSON-LD
processing mode.ExpansionApi
numericId()
Experimental: Accept numeric @id.ExpansionApi
options(JsonLdOptions options)
Override an existing settings withJsonLdOptions
.ExpansionApi
ordered(boolean enable)
If set totrue
, certain algorithm processing steps are ordered lexicographically.ExpansionApi
rdfStar()
Experimental: Enables JSON-LD-STAR extension.
-
-
-
Field Detail
-
documentUri
private final java.net.URI documentUri
-
document
private final Document document
-
options
private JsonLdOptions options
-
-
Constructor Detail
-
ExpansionApi
public ExpansionApi(java.net.URI documentUri)
-
ExpansionApi
public ExpansionApi(Document document)
-
-
Method Detail
-
options
public ExpansionApi options(JsonLdOptions options)
Description copied from interface:CommonApi
Override an existing settings withJsonLdOptions
.- Specified by:
options
in interfaceCommonApi<ExpansionApi>
- Parameters:
options
-JsonLdOptions
- Returns:
- builder instance
-
context
public ExpansionApi context(java.net.URI contextUri)
Description copied from interface:ContextApi
A context that is used to initialize the active context.- Specified by:
context
in interfaceContextApi<ExpansionApi>
- Parameters:
contextUri
-URI
referring to a context- Returns:
- builder instance
-
context
public ExpansionApi context(java.lang.String contextLocation)
Description copied from interface:ContextApi
A context that is used to initialize the active context.- Specified by:
context
in interfaceContextApi<ExpansionApi>
- Parameters:
contextLocation
-IRI
referring to a context- Returns:
- builder instance
-
context
public ExpansionApi context(jakarta.json.JsonStructure context)
Description copied from interface:ContextApi
A context that is used to initialize the active context.- Specified by:
context
in interfaceContextApi<ExpansionApi>
- Parameters:
context
-JsonObject
, a sequence ofJsonObject
, or aJsonString
representing anIRI
- Returns:
- builder instance
-
context
public ExpansionApi context(Document context)
Description copied from interface:ContextApi
A context that is used to initialize the active context.- Specified by:
context
in interfaceContextApi<ExpansionApi>
- Parameters:
context
-Document
representing a context- Returns:
- builder instance
-
mode
public ExpansionApi mode(JsonLdVersion processingMode)
Description copied from interface:CommonApi
SetJSON-LD
processing mode. JSON-LD 1.1 is set by default.- Specified by:
mode
in interfaceCommonApi<ExpansionApi>
- Parameters:
processingMode
- to set- Returns:
- builder instance
-
base
public ExpansionApi base(java.net.URI baseUri)
Description copied from interface:CommonApi
Set the baseIRI
. If set, this overrides the input document's IRI.- Specified by:
base
in interfaceCommonApi<ExpansionApi>
- Returns:
- builder instance
-
loader
public ExpansionApi loader(DocumentLoader loader)
Description copied from interface:LoaderApi
Set 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.- Specified by:
loader
in interfaceLoaderApi<ExpansionApi>
- Returns:
- builder instance
-
ordered
public ExpansionApi ordered(boolean enable)
Description copied from interface:CommonApi
If set totrue
, certain algorithm processing steps are ordered lexicographically. Iffalse
, order is not considered in processing.- Specified by:
ordered
in interfaceCommonApi<ExpansionApi>
- Returns:
- builder instance
-
get
public jakarta.json.JsonArray get() throws JsonLdError
Get the result of the document expansion.- Returns:
JsonArray
representing expanded document- Throws:
JsonLdError
-
numericId
public ExpansionApi numericId()
Experimental: Accept numeric @id. Disabled by default.- Returns:
- builder instance
-
rdfStar
public ExpansionApi rdfStar()
Experimental: Enables JSON-LD-STAR extension. Disabled by default.- Returns:
- builder instance
- See Also:
- JSON-LD-STAR Draft
-
-