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