Package com.apicatalog.jsonld.api

Class ExpansionApi

java.lang.Object

com.apicatalog.jsonld.api.ExpansionApi

All Implemented Interfaces:

CommonApi<ExpansionApi>, ContextApi<ExpansionApi>, LoaderApi<ExpansionApi>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ExpansionApi	base(URI baseUri)	Set the base IRI.
ExpansionApi	context(Document context)	A context that is used to initialize the active context.
ExpansionApi	context(jakarta.json.JsonStructure context)	A context that is used to initialize the active context.
ExpansionApi	context(String contextLocation)	A context that is used to initialize the active context.
ExpansionApi	context(URI contextUri)	A context that is used to initialize the active context.
jakarta.json.JsonArray	get()	Get the result of the document expansion.
ExpansionApi	loader(DocumentLoader loader)	Set the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader.
ExpansionApi	mode(JsonLdVersion processingMode)	Set JSON-LD processing mode.
ExpansionApi	numericId()	Experimental: Accept numeric @id.
ExpansionApi	options(JsonLdOptions options)	Override an existing settings with JsonLdOptions.
ExpansionApi	ordered(boolean enable)	If set to true, certain algorithm processing steps are ordered lexicographically.
ExpansionApi	rdfStar()	Experimental: Enables JSON-LD-STAR extension.

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

ExpansionApi

public ExpansionApi(URI documentUri)

ExpansionApi

public ExpansionApi(Document document)

Method Detail

options

public ExpansionApi options(JsonLdOptions options)

Description copied from interface: CommonApi

Override an existing settings with JsonLdOptions.

Specified by:

options in interface CommonApi<ExpansionApi>

Parameters:

options - JsonLdOptions

Returns:

builder instance

context

public ExpansionApi context(URI contextUri)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ExpansionApi>

Parameters:

contextUri - URI referring to a context

Returns:

builder instance

context

public ExpansionApi context(String contextLocation)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ExpansionApi>

Parameters:

contextLocation - IRI referring to a context

Returns:

builder instance

context

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

Parameters:

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

Returns:

builder instance

context

public ExpansionApi context(Document context)

Description copied from interface: ContextApi

A context that is used to initialize the active context.

Specified by:

context in interface ContextApi<ExpansionApi>

Parameters:

context - Document representing a context

Returns:

builder instance

mode

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

Parameters:

processingMode - to set

Returns:

builder instance

base

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

Returns:

builder instance

loader

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

Returns:

builder instance

ordered

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

Returns:

builder instance

get

public jakarta.json.JsonArray get()
                           throws JsonLdError

Get the result of the document expansion.

Returns:

JsonArray representing expanded document

Throws:

JsonLdError

numericId

public ExpansionApi numericId()

Experimental: Accept numeric @id. Disabled by default.

Returns:

builder instance

rdfStar

public ExpansionApi rdfStar()

Experimental: Enables JSON-LD-STAR extension. Disabled by default.

Returns:

builder instance

See Also:

JSON-LD-STAR Draft