Package com.apicatalog.jsonld.api

Class FramingApi

java.lang.Object

com.apicatalog.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>

Constructor Summary

Constructors

Constructor	Description
FramingApi(Document document, Document frame)
FramingApi(Document document, URI frameUri)
FramingApi(URI documentUri, Document frame)
FramingApi(URI documentUri, URI frameUri)

Method Summary

Modifier and Type	Method	Description
FramingApi	base(URI baseUri)	Set the base IRI.
FramingApi	context(Document context)	A context that is used to initialize the active context.
FramingApi	context(jakarta.json.JsonStructure context)	A context that is used to initialize the active context.
FramingApi	context(String contextLocation)	A context that is used to initialize the active context.
FramingApi	context(URI contextUri)	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 the DocumentLoader.
FramingApi	mode(JsonLdVersion processingMode)	Set JSON-LD processing mode.
FramingApi	omitDefault()
FramingApi	omitDefault(boolean enable)
FramingApi	omitGraph()
FramingApi	omitGraph(boolean enable)
FramingApi	options(JsonLdOptions options)	Override an existing settings with JsonLdOptions.
FramingApi	ordered(boolean enable)	If set to true, certain algorithm processing steps are ordered lexicographically.
FramingApi	requiredAll()
FramingApi	requiredAll(boolean enable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.apicatalog.jsonld.api.CommonApi

base, ordered

Constructor Detail

FramingApi

public FramingApi(URI documentUri,
                  URI frameUri)

FramingApi

public FramingApi(Document document,
                  Document frame)

FramingApi

public FramingApi(Document document,
                  URI frameUri)

FramingApi

public FramingApi(URI documentUri,
                  Document frame)

Method Detail

options

public FramingApi options(JsonLdOptions options)

Description copied from interface: CommonApi

Override an existing settings with JsonLdOptions.

Specified by:

options in interface CommonApi<FramingApi>

Parameters:

options - JsonLdOptions

Returns:

builder instance

context

public FramingApi context(URI contextUri)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<FramingApi>

Parameters:

contextUri - URI referring to a context

Returns:

builder instance

context

public FramingApi context(String contextLocation)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<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 interface ContextApi<FramingApi>

Parameters:

context - JsonObject, a sequence of JsonObject, or a JsonString representing an IRI

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 interface ContextApi<FramingApi>

Parameters:

context - Document representing a context

Returns:

builder instance

mode

public FramingApi mode(JsonLdVersion processingMode)

Description copied from interface: CommonApi

Set JSON-LD processing mode. JSON-LD 1.1 is set by default.

Specified by:

mode in interface CommonApi<FramingApi>

Parameters:

processingMode - to set

Returns:

builder instance

base

public FramingApi base(URI baseUri)

Description copied from interface: CommonApi

Set the base IRI. If set, this overrides the input document's IRI.

Specified by:

base in interface CommonApi<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 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.

Specified by:

loader in interface LoaderApi<FramingApi>

Returns:

builder instance

ordered

public FramingApi ordered(boolean enable)

Description copied from interface: CommonApi

If set to true, certain algorithm processing steps are ordered lexicographically. If false, order is not considered in processing.

Specified by:

ordered in interface CommonApi<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