Package com.apicatalog.jsonld.api

Class FlatteningApi

java.lang.Object

com.apicatalog.jsonld.api.FlatteningApi

All Implemented Interfaces:

CommonApi<FlatteningApi>, ContextApi<FlatteningApi>, LoaderApi<FlatteningApi>

public final class FlatteningApi
extends Object
implements CommonApi<FlatteningApi>, LoaderApi<FlatteningApi>, ContextApi<FlatteningApi>

Constructor Summary

Constructors

Constructor	Description
FlatteningApi(Document document)
FlatteningApi(URI documentUri)

Method Summary

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

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

FlatteningApi

public FlatteningApi(URI documentUri)

FlatteningApi

public FlatteningApi(Document document)

Method Detail

options

public FlatteningApi options(JsonLdOptions options)

Description copied from interface: CommonApi

Override an existing settings with JsonLdOptions.

Specified by:

options in interface CommonApi<FlatteningApi>

Parameters:

options - JsonLdOptions

Returns:

builder instance

mode

public FlatteningApi 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<FlatteningApi>

Parameters:

processingMode - to set

Returns:

builder instance

base

public FlatteningApi 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<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 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<FlatteningApi>

Returns:

builder instance

ordered

public FlatteningApi 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<FlatteningApi>

Returns:

builder instance

context

public FlatteningApi context(URI contextUri)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<FlatteningApi>

Parameters:

contextUri - URI referring to a context

Returns:

builder instance

context

public FlatteningApi context(String contextLocation)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

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

Parameters:

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

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