Package no.hasmac.jsonld.api
Class FlatteningApi
- java.lang.Object
-
- no.hasmac.jsonld.api.FlatteningApi
-
- All Implemented Interfaces:
CommonApi<FlatteningApi>
,ContextApi<FlatteningApi>
,LoaderApi<FlatteningApi>
public final class FlatteningApi extends java.lang.Object implements CommonApi<FlatteningApi>, LoaderApi<FlatteningApi>, ContextApi<FlatteningApi>
-
-
Field Summary
Fields Modifier and Type Field Description private Document
context
private java.net.URI
contextUri
private Document
document
private java.net.URI
documentUri
private JsonLdOptions
options
-
Constructor Summary
Constructors Constructor Description FlatteningApi(java.net.URI documentUri)
FlatteningApi(Document document)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatteningApi
base(java.net.URI baseUri)
Set the baseIRI
.FlatteningApi
compactArrays()
FlatteningApi
compactArrays(boolean enable)
FlatteningApi
context(jakarta.json.JsonStructure context)
A context that is used to initialize the active context.FlatteningApi
context(java.lang.String contextLocation)
A context that is used to initialize the active context.FlatteningApi
context(java.net.URI contextUri)
A context that is used to initialize the active context.FlatteningApi
context(Document context)
A context that is used to initialize the active context.jakarta.json.JsonStructure
get()
Get the result of flattening.FlatteningApi
loader(DocumentLoader loader)
Set the loader to be used to retrieve remote documents and contexts, implementing theDocumentLoader
.FlatteningApi
mode(JsonLdVersion processingMode)
SetJSON-LD
processing mode.FlatteningApi
options(JsonLdOptions options)
Override an existing settings withJsonLdOptions
.FlatteningApi
ordered(boolean enable)
If set totrue
, certain algorithm processing steps are ordered lexicographically.
-
-
-
Field Detail
-
documentUri
private final java.net.URI documentUri
-
document
private final Document document
-
context
private Document context
-
contextUri
private java.net.URI contextUri
-
options
private JsonLdOptions options
-
-
Constructor Detail
-
FlatteningApi
public FlatteningApi(java.net.URI documentUri)
-
FlatteningApi
public FlatteningApi(Document document)
-
-
Method Detail
-
options
public FlatteningApi options(JsonLdOptions options)
Description copied from interface:CommonApi
Override an existing settings withJsonLdOptions
.- Specified by:
options
in interfaceCommonApi<FlatteningApi>
- Parameters:
options
-JsonLdOptions
- Returns:
- builder instance
-
mode
public FlatteningApi 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<FlatteningApi>
- Parameters:
processingMode
- to set- Returns:
- builder instance
-
base
public FlatteningApi 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<FlatteningApi>
- Returns:
- builder instance
-
compactArrays
public FlatteningApi compactArrays(boolean enable)
-
compactArrays
public FlatteningApi compactArrays()
-
loader
public FlatteningApi 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<FlatteningApi>
- Returns:
- builder instance
-
ordered
public FlatteningApi 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<FlatteningApi>
- Returns:
- builder instance
-
context
public FlatteningApi 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<FlatteningApi>
- Parameters:
contextUri
-URI
referring to a context- Returns:
- builder instance
-
context
public FlatteningApi 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<FlatteningApi>
- Parameters:
contextLocation
-IRI
referring to a context- Returns:
- builder instance
-
context
public FlatteningApi 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<FlatteningApi>
- Parameters:
context
-JsonObject
, a sequence ofJsonObject
, or aJsonString
representing anIRI
- Returns:
- builder instance
-
context
public FlatteningApi context(Document context)
Description copied from interface:ContextApi
A context that is used to initialize the active context.- Specified by:
context
in interfaceContextApi<FlatteningApi>
- Parameters:
context
-Document
representing a context- Returns:
- builder instance
-
get
public jakarta.json.JsonStructure get() throws JsonLdError
Get the result of flattening.- Returns:
JsonStructure
representing flattened document- Throws:
JsonLdError
-
-