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 Object
implements CommonApi<FramingApi>, LoaderApi<FramingApi>, ContextApi<FramingApi>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Document
private final URI
private final Document
private final URI
private JsonLdOptions
-
Constructor Summary
ConstructorsConstructorDescriptionFramingApi
(URI documentUri, URI frameUri) FramingApi
(URI documentUri, Document frame) FramingApi
(Document document, URI frameUri) FramingApi
(Document document, Document frame) -
Method Summary
Modifier and TypeMethodDescriptionSet the baseIRI
.context
(jakarta.json.JsonStructure context) A context that is used to initialize the active context.A context that is used to initialize the active context.A context that is used to initialize the active context.A context that is used to initialize the active context.embed
(JsonLdEmbed value) explicit()
explicit
(boolean enable) jakarta.json.JsonObject
get()
Get the result of framing.loader
(DocumentLoader loader) Set the loader to be used to retrieve remote documents and contexts, implementing theDocumentLoader
.mode
(JsonLdVersion processingMode) SetJSON-LD
processing mode.omitDefault
(boolean enable) omitGraph
(boolean enable) options
(JsonLdOptions options) Override an existing settings withJsonLdOptions
.ordered
(boolean enable) If set totrue
, certain algorithm processing steps are ordered lexicographically.requiredAll
(boolean enable)
-
Field Details
-
document
-
documentUri
-
frame
-
frameUri
-
options
-
-
Constructor Details
-
FramingApi
-
FramingApi
-
FramingApi
-
FramingApi
-
-
Method Details
-
options
Description copied from interface:CommonApi
Override an existing settings withJsonLdOptions
.- Specified by:
options
in interfaceCommonApi<FramingApi>
- Parameters:
options
-JsonLdOptions
- Returns:
- builder instance
-
context
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
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
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
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
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
Description copied from interface:CommonApi
Set the baseIRI
. If set, this overrides the input document's IRI.- Specified by:
base
in interfaceCommonApi<FramingApi>
- Parameters:
baseUri
-- Returns:
- builder instance
-
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>
- Parameters:
loader
-- Returns:
- builder instance
-
ordered
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>
- Parameters:
enable
-- Returns:
- builder instance
-
embed
-
explicit
-
explicit
-
omitDefault
-
omitDefault
-
omitGraph
-
omitGraph
-
requiredAll
-
requiredAll
-
get
Get the result of framing.- Returns:
JsonObject
representing framed document- Throws:
JsonLdError
-