Package org.eclipse.rdf4j.rio.jsonld

Class JSONLDWriter

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter

org.eclipse.rdf4j.rio.jsonld.JSONLDWriter

All Implemented Interfaces:

CharSink, Sink, RDFHandler, RDFWriter

public class JSONLDWriter
extends AbstractRDFWriter
implements CharSink

An RDFWriter for JSON-LD 1.1

Author:

Håvard M. Ottestad

Field Summary

Fields inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter

namespaceTable, statementConsumer

Constructor Summary

Constructors

Constructor	Description
JSONLDWriter(OutputStream outputStream)	Create a JSONLDWriter using a OutputStream
JSONLDWriter(OutputStream outputStream, String baseURI)	Create a JSONLDWriter using a OutputStream
JSONLDWriter(Writer writer)	Create a JSONLDWriter using a Writer
JSONLDWriter(Writer writer, String baseURI)	Create a JSONLDWriter using a Writer

Method Summary

Modifier and Type	Method	Description
void	consumeStatement(Statement st)	Consume a statement.
void	endRDF()	Signals the end of the RDF data.
RDFFormat	getRDFFormat()	Gets the RDF format that this RDFWriter uses.
Collection<RioSetting<?>>	getSupportedSettings()
Writer	getWriter()	get the Writer used by this CharSink.
void	handleComment(String comment)	Handles a comment.
void	handleNamespace(String prefix, String uri)	Handles a namespace declaration/definition.
void	startRDF()	Signals the start of the RDF data.

Methods inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter

checkWritingStarted, getFileFormat, getWriterConfig, handleStatement, isWritingStarted, set, setWriterConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.rdf4j.common.io.Sink

acceptsFileFormat, getFileFormat

Constructor Details

JSONLDWriter

public JSONLDWriter(OutputStream outputStream)

Create a JSONLDWriter using a OutputStream

Parameters:

outputStream - The OutputStream to write to.

JSONLDWriter

public JSONLDWriter(OutputStream outputStream,
 String baseURI)

Create a JSONLDWriter using a OutputStream

Parameters:

outputStream - The OutputStream to write to.

baseURI - base URI

JSONLDWriter

public JSONLDWriter(Writer writer)

Create a JSONLDWriter using a Writer

Parameters:

writer - The Writer to write to.

JSONLDWriter

public JSONLDWriter(Writer writer,
 String baseURI)

Create a JSONLDWriter using a Writer

Parameters:

writer - The Writer to write to.

baseURI - base URI

Method Details

getWriter

public Writer getWriter()

Description copied from interface: CharSink

get the Writer used by this CharSink.

Specified by:

getWriter in interface CharSink

Returns:

an Writer

handleNamespace

public void handleNamespace(String prefix,
 String uri)
                     throws RDFHandlerException

Description copied from interface: RDFHandler

Handles a namespace declaration/definition. A namespace declaration associates a (short) prefix string with the namespace's URI. The prefix for default namespaces, which do not have an associated prefix, are represented as empty strings.

Specified by:

handleNamespace in interface RDFHandler

Overrides:

handleNamespace in class AbstractRDFWriter

Parameters:

prefix - The prefix for the namespace, or an empty string in case of a default namespace.

uri - The URI that the prefix maps to.

Throws:

RDFHandlerException - If the RDF handler has encountered an unrecoverable error.

startRDF

public void startRDF()
              throws RDFHandlerException

Description copied from interface: RDFHandler

Signals the start of the RDF data. This method is called before any data is reported.

Specified by:

startRDF in interface RDFHandler

Overrides:

startRDF in class AbstractRDFWriter

Throws:

RDFHandlerException - If the RDF handler has encountered an unrecoverable error.

endRDF

public void endRDF()
            throws RDFHandlerException

Description copied from interface: RDFHandler

Signals the end of the RDF data. This method is called when all data has been reported.

Specified by:

endRDF in interface RDFHandler

Throws:

RDFHandlerException - If the RDF handler has encountered an unrecoverable error.

consumeStatement

public void consumeStatement(Statement st)
                      throws RDFHandlerException

Description copied from class: AbstractRDFWriter

Consume a statement.

Extending classes must override this method instead of overriding AbstractRDFWriter.handleStatement(Statement) in order to benefit from automatic handling of RDF-star conversion or encoding.

Overrides:

consumeStatement in class AbstractRDFWriter

Parameters:

st - the statement to consume.

Throws:

RDFHandlerException

handleComment

public void handleComment(String comment)
                   throws RDFHandlerException

Description copied from interface: RDFHandler

Handles a comment.

Specified by:

handleComment in interface RDFHandler

Parameters:

comment - The comment.

Throws:

RDFHandlerException - If the RDF handler has encountered an unrecoverable error.

getRDFFormat

public RDFFormat getRDFFormat()

Description copied from interface: RDFWriter

Gets the RDF format that this RDFWriter uses.

Specified by:

getRDFFormat in interface RDFWriter

getSupportedSettings

public Collection<RioSetting<?>> getSupportedSettings()

Specified by:

getSupportedSettings in interface RDFWriter

Overrides:

getSupportedSettings in class AbstractRDFWriter

Returns:

A collection of RioSettings that are supported by this RDFWriter.