Class NTriplesWriter

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter

org.eclipse.rdf4j.rio.ntriples.NTriplesWriter

All Implemented Interfaces:

CharSink, Sink, RDFHandler, RDFWriter

Direct Known Subclasses:

NQuadsWriter

public class NTriplesWriter
extends AbstractRDFWriter
implements CharSink

An implementation of the RDFWriter interface that writes RDF documents in N-Triples format. The N-Triples format is defined in this section of the RDF Test Cases document.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Writer	writer

Fields inherited from class AbstractRDFWriter

namespaceTable, statementConsumer

Modifier and Type	Field	Description
protected Map<String,String>	namespaceTable	Mapping from namespace prefixes to namespace names.
protected Consumer<Statement>	statementConsumer

Constructor Summary

Constructors

Constructor	Description
NTriplesWriter(OutputStream out)	Creates a new NTriplesWriter that will write to the supplied OutputStream.
NTriplesWriter(Writer writer)	Creates a new NTriplesWriter that will write to the supplied Writer.

Method Summary

Modifier and Type	Method	Description
protected 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.
final Collection<RioSetting<?>>	getSupportedSettings()
Writer	getWriter()	get the Writer used by this CharSink.
void	handleComment(String comment)	Handles a comment.
void	handleNamespace(String prefix, String name)	Handles a namespace declaration/definition.
protected boolean	requiresVersionAnnouncement()	Override to return true for writers where an inline version announcement is mandatory when RDF 1.2-specific features are serialised (Turtle, TriG, N3, N-Triples, N-Quads).
void	startRDF()	Signals the start of the RDF data.
protected void	writeValue(Value value)	Writes the N-Triples representation of the given Value.
protected void	writeVersionAnnouncement()	Writes the N-Triples / N-Quads version directive as the very first output line once an RDF 1.2 feature is detected.

Methods inherited from class AbstractRDFWriter

checkWritingStarted, ensureVersionAnnouncement, getFileFormat, getWriterConfig, handleStatement, isRdf12Feature, isRdf12FeatureDetected, isVersionAnnouncementWritten, isWritingStarted, noteRdf12Feature, prepareForVersionAnnouncement, set, setWriterConfig

Modifier and Type	Method	Description
protected void	checkWritingStarted()	Verify that writing has started.
protected final void	ensureVersionAnnouncement()	Emits the version announcement if — and only if — all of the following hold: at least one RDF 1.2 feature has been observed (AbstractRDFWriter.noteRdf12Feature(Value...)); the announcement has not been written yet; AbstractRDFWriter.requiresVersionAnnouncement() returns true. Calls AbstractRDFWriter.prepareForVersionAnnouncement() before writing to let writers close any open output structure first.
FileFormat	getFileFormat()	Get the FileFormat this sink uses.
WriterConfig	getWriterConfig()	Retrieves the current writer configuration as a single object.
void	handleStatement(Statement st)	Handles a statement.
static boolean	isRdf12Feature(Value v)	Returns true if the given Value requires an RDF 1.2 version announcement (i.e. it is a triple term or a directional language-tagged literal).
protected boolean	isRdf12FeatureDetected()	Returns true if at least one RDF 1.2-specific feature has been noted so far.
protected boolean	isVersionAnnouncementWritten()	Returns true if the version announcement has already been written to the output stream.
protected boolean	isWritingStarted()	See if writing has started
protected void	noteRdf12Feature(Value... values)	Records that an RDF 1.2-specific feature was observed in values.
protected void	prepareForVersionAnnouncement()	Called by AbstractRDFWriter.ensureVersionAnnouncement() immediately before AbstractRDFWriter.writeVersionAnnouncement().
<T> RDFWriter	set(RioSetting<T> setting, T value)	Set a setting on the writer, and return this writer object to allow chaining.
RDFWriter	setWriterConfig(WriterConfig config)	Sets all supplied writer configuration options.

Methods inherited from class Object

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

Methods inherited from interface Sink

acceptsFileFormat

Modifier and Type	Method	Description
default boolean	acceptsFileFormat(FileFormat format)	Check if this Sink accepts the supplied FileFormat.

Field Details

writer

protected final Writer writer

Constructor Details

NTriplesWriter

public NTriplesWriter(OutputStream out)

Creates a new NTriplesWriter that will write to the supplied OutputStream.

Parameters:

out - The OutputStream to write the N-Triples document to.

NTriplesWriter

public NTriplesWriter(Writer writer)

Creates a new NTriplesWriter that will write to the supplied Writer.

Parameters:

writer - The Writer to write the N-Triples document to.

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

getRDFFormat

public RDFFormat getRDFFormat()

Description copied from interface: RDFWriter

Gets the RDF format that this RDFWriter uses.

Specified by:

getRDFFormat in interface RDFWriter

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.

requiresVersionAnnouncement

protected boolean requiresVersionAnnouncement()

Description copied from class: AbstractRDFWriter

Override to return true for writers where an inline version announcement is mandatory when RDF 1.2-specific features are serialised (Turtle, TriG, N3, N-Triples, N-Quads).

Returns false by default (JSON-LD, RDF/JSON, NDJSON-LD writers keep it optional).

Overrides:

requiresVersionAnnouncement in class AbstractRDFWriter

writeVersionAnnouncement

protected void writeVersionAnnouncement()
                                 throws RDFHandlerException

Writes the N-Triples / N-Quads version directive as the very first output line once an RDF 1.2 feature is detected. Per the RDF 1.2 N-Triples specification, this must appear before any triple that uses a version-dependent feature.

Overrides:

writeVersionAnnouncement in class AbstractRDFWriter

Throws:

RDFHandlerException

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.

handleNamespace

public void handleNamespace(String prefix,
 String name)

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.

name - The URI that the prefix maps to.

consumeStatement

protected void consumeStatement(Statement st)

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 1.2 conversion or encoding.

Overrides:

consumeStatement in class AbstractRDFWriter

Parameters:

st - the statement to consume.

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.

getSupportedSettings

public final 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.

writeValue

protected void writeValue(Value value)
                   throws IOException

Writes the N-Triples representation of the given Value.

Parameters:

value - The value to write.

Throws:

IOException