Package com.apicatalog.jsonld.serialization

Class QuadsToJsonld

java.lang.Object

com.apicatalog.jsonld.serialization.QuadsToJsonld

All Implemented Interfaces:

com.apicatalog.rdf.api.RdfQuadConsumer

public class QuadsToJsonld
extends java.lang.Object
implements com.apicatalog.rdf.api.RdfQuadConsumer

QuadsToJsonld implements RdfQuadConsumer and provides functionality to transform an RDF quad set into a JSON-LD document in expanded form.

The transformation process involves processing compound literal subjects, lists, blank nodes, and constructing JSON-LD representations for both default and named graphs.

This class can be configured using methods such as ordered(boolean), rdfDirection(RdfDirection), useNativeTypes(boolean), useRdfType(boolean), mode(JsonLdVersion), and uriValidation(UriValidationPolicy).

Key methods include:

• reset() to clear the internal state for reuse.
• toJsonLd() to generate the JSON-LD output from the processed quads.
• quad(String, String, String, String, String, String, String) to ingest a single RDF quad.

Since:

1.7.0

See Also:

RdfQuadConsumer

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Boolean>>	compoundLiteralSubjects
protected GraphMap	graphMap
protected boolean	ordered
protected JsonLdVersion	processingMode
protected JsonLdOptions.RdfDirection	rdfDirection
protected java.util.Map<java.lang.String,GraphMap.Reference>	referenceOnce
protected UriValidationPolicy	uriValidation
protected boolean	useNativeTypes
protected boolean	useRdfType

Constructor Summary

Constructors

Constructor	Description
QuadsToJsonld()

Method Summary

Modifier and Type	Method	Description
QuadsToJsonld	mode(JsonLdVersion processingMode)	Sets the JSON-LD processing mode.
QuadsToJsonld	options(JsonLdOptions options)
QuadsToJsonld	ordered(boolean ordered)	Configures whether the output should be ordered.
com.apicatalog.rdf.api.RdfQuadConsumer	quad(java.lang.String subject, java.lang.String predicate, java.lang.String object, java.lang.String datatype, java.lang.String language, java.lang.String direction, java.lang.String graph)
QuadsToJsonld	rdfDirection(JsonLdOptions.RdfDirection rdfDirection)	Sets the RDF direction configuration.
QuadsToJsonld	reset()	Resets the consumer to an empty state, allowing the same instance to process different datasets.
jakarta.json.JsonArray	toJsonLd()	Generates a new JSON-LD representation based on the received quads.
(package private) jakarta.json.JsonObject	toObject(java.lang.String object, java.lang.String datatype, java.lang.String langTag, java.lang.String direction)
QuadsToJsonld	uriValidation(UriValidationPolicy uriValidation)	Sets the URI validation policy.
QuadsToJsonld	useNativeTypes(boolean useNativeTypes)	Configures whether to use native types for literal conversion.
QuadsToJsonld	useRdfType(boolean useRdfType)

Methods inherited from class java.lang.Object

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

Field Detail

ordered

protected boolean ordered

rdfDirection

protected JsonLdOptions.RdfDirection rdfDirection

useNativeTypes

protected boolean useNativeTypes

useRdfType

protected boolean useRdfType

uriValidation

protected UriValidationPolicy uriValidation

processingMode

protected JsonLdVersion processingMode

graphMap

protected GraphMap graphMap

compoundLiteralSubjects

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Boolean>> compoundLiteralSubjects

referenceOnce

protected java.util.Map<java.lang.String,GraphMap.Reference> referenceOnce

Constructor Detail

QuadsToJsonld

public QuadsToJsonld()

Method Detail

ordered

public QuadsToJsonld ordered(boolean ordered)

Configures whether the output should be ordered.

Parameters:

ordered - true if ordering is required; false otherwise

Returns:

this instance for chaining

rdfDirection

public QuadsToJsonld rdfDirection(JsonLdOptions.RdfDirection rdfDirection)

Sets the RDF direction configuration.

Parameters:

rdfDirection - the RDF direction (e.g., COMPOUND_LITERAL)

Returns:

this instance for chaining

useNativeTypes

public QuadsToJsonld useNativeTypes(boolean useNativeTypes)

Configures whether to use native types for literal conversion.

Parameters:

useNativeTypes - true to use native types; false otherwise

Returns:

this instance for chaining

useRdfType

public QuadsToJsonld useRdfType(boolean useRdfType)

mode

public QuadsToJsonld mode(JsonLdVersion processingMode)

Sets the JSON-LD processing mode.

Parameters:

processingMode - the processing mode (e.g., V1_0, V1_1)

Returns:

this instance for chaining

uriValidation

public QuadsToJsonld uriValidation(UriValidationPolicy uriValidation)

Sets the URI validation policy.

Parameters:

uriValidation - the URI validation policy

Returns:

this instance for chaining

options

public QuadsToJsonld options(JsonLdOptions options)

reset

public QuadsToJsonld reset()

Resets the consumer to an empty state, allowing the same instance to process different datasets.

Returns:

the current QuadsToJsonld instance after resetting

toJsonLd

public jakarta.json.JsonArray toJsonLd()
                                throws JsonLdError

Generates a new JSON-LD representation based on the received quads.

This method processes all the quads stored in the internal graph map and transforms them into a JSON-LD document in expanded form.

Returns:

a JsonArray containing the generated JSON-LD data

Throws:

JsonLdError - if an error occurs during JSON-LD generation

quad

public com.apicatalog.rdf.api.RdfQuadConsumer quad(java.lang.String subject,
                                                   java.lang.String predicate,
                                                   java.lang.String object,
                                                   java.lang.String datatype,
                                                   java.lang.String language,
                                                   java.lang.String direction,
                                                   java.lang.String graph)
                                            throws com.apicatalog.rdf.api.RdfConsumerException

Specified by:

quad in interface com.apicatalog.rdf.api.RdfQuadConsumer

Throws:

com.apicatalog.rdf.api.RdfConsumerException

toObject

jakarta.json.JsonObject toObject(java.lang.String object,
                                 java.lang.String datatype,
                                 java.lang.String langTag,
                                 java.lang.String direction)
                          throws com.apicatalog.rdf.api.RdfConsumerException

Throws:

com.apicatalog.rdf.api.RdfConsumerException