Class TriGWriter

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter

org.eclipse.rdf4j.rio.turtle.TurtleWriter

org.eclipse.rdf4j.rio.trig.TriGWriter

All Implemented Interfaces:

CharSink, Sink, RDFHandler, RDFWriter

public class TriGWriter
extends TurtleWriter

An extension of TurtleWriter that writes RDF documents in TriG format by adding graph scopes to the Turtle document.

Author:

Arjohn Kampman

Field Summary

Fields inherited from class TurtleWriter

baseIRI, bufferedStatements, lastWrittenPredicate, lastWrittenSubject, statementClosed, writer

Modifier and Type	Field	Description
protected ParsedIRI	baseIRI
protected Model	bufferedStatements
protected IRI	lastWrittenPredicate
protected Resource	lastWrittenSubject
protected boolean	statementClosed	Flag indicating whether the last written statement has been closed.
protected IndentingWriter	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
TriGWriter(OutputStream out)	Creates a new TriGWriter that will write to the supplied OutputStream.
TriGWriter(OutputStream out, ParsedIRI baseIRI)	Creates a new TriGWriter that will write to the supplied OutputStream.
TriGWriter(Writer writer)	Creates a new TriGWriter that will write to the supplied Writer.
TriGWriter(Writer writer, ParsedIRI baseIRI)	Creates a new TriGWriter that will write to the supplied Writer.

Method Summary

Modifier and Type	Method	Description
protected void	closeActiveContext()
void	endRDF()	Signals the end of the RDF data.
RDFFormat	getRDFFormat()	Gets the RDF format that this RDFWriter uses.
void	startRDF()	Signals the start of the RDF data.
protected void	writeNamespace(String prefix, String name)
protected void	writeStatement(Resource subj, IRI pred, Value obj, Resource context, boolean canShortenSubject, boolean canShortenObject)
protected void	writeVersionAnnouncement()	Writes the format-specific version directive to the output stream.

Methods inherited from class TurtleWriter

closePreviousStatement, consumeStatement, getModelFactory, getSupportedSettings, getWriter, handleComment, handleNamespace, handleStatementInternal, prepareForVersionAnnouncement, requiresVersionAnnouncement, setModelFactory, writeBase, writeBNode, writeBNode, writeCommentLine, writeLiteral, writePredicate, writeResource, writeResource, writeTriple, writeURI, writeValue, writeValue

Modifier and Type	Method	Description
protected void	closePreviousStatement()
protected void	consumeStatement(Statement st)	Consume a statement.
protected ModelFactory	getModelFactory()
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 void	handleStatementInternal(Statement st, boolean endRDFCalled, boolean canShortenSubjectBNode, boolean canShortenObjectBNode)	Internal method that differentiates between the pretty-print and streaming writer cases.
protected void	prepareForVersionAnnouncement()	Closes any open predicate-object list or blank-node structure before the version directive is written.
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	setModelFactory(ModelFactory modelFactory)	Set a ModelFactory to use for creating internal Models for statement processing/buffering purposes.
protected void	writeBase(String baseURI)
protected void	writeBNode(BNode bNode)	Deprecated. Use TurtleWriter.writeBNode(BNode, boolean) instead.
protected void	writeBNode(BNode bNode, boolean canShorten)
protected void	writeCommentLine(String line)
protected void	writeLiteral(Literal lit)
protected void	writePredicate(IRI predicate)
protected void	writeResource(Resource res)	Deprecated. Use TurtleWriter.writeResource(Resource, boolean) instead.
protected void	writeResource(Resource res, boolean canShorten)	Writes a Resource, optionally shortening it if it is an IRI and has a namespace definition that is suitable for use in this context for shortening or a BNode that has been confirmed to be able to be shortened in this context.
protected void	writeTriple(TripleTerm tripleTerm, boolean canShorten)
protected void	writeURI(IRI uri)
protected void	writeValue(Value val)	Deprecated. Use TurtleWriter.writeValue(Value, boolean) instead.
protected void	writeValue(Value val, boolean canShorten)	Writes a value, optionally shortening it if it is an IRI and has a namespace definition that is suitable for use in this context for shortening or a BNode that has been confirmed to be able to be shortened in this context.

Methods inherited from class AbstractRDFWriter

checkWritingStarted, ensureVersionAnnouncement, getFileFormat, getWriterConfig, handleStatement, isRdf12Feature, isRdf12FeatureDetected, isVersionAnnouncementWritten, isWritingStarted, noteRdf12Feature, 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.
<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.

Constructor Details

TriGWriter

public TriGWriter(OutputStream out)

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

Parameters:

out - The OutputStream to write the TriG document to.

TriGWriter

public TriGWriter(OutputStream out,
 ParsedIRI baseIRI)

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

Parameters:

out - The OutputStream to write the TriG document to.

baseIRI -

TriGWriter

public TriGWriter(Writer writer)

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

Parameters:

writer - The Writer to write the TriG document to.

TriGWriter

public TriGWriter(Writer writer,
 ParsedIRI baseIRI)

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

Parameters:

writer - The Writer to write the TriG document to.

baseIRI -

Method Details

getRDFFormat

public RDFFormat getRDFFormat()

Description copied from interface: RDFWriter

Gets the RDF format that this RDFWriter uses.

Specified by:

getRDFFormat in interface RDFWriter

Overrides:

getRDFFormat in class TurtleWriter

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 TurtleWriter

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

Overrides:

endRDF in class TurtleWriter

Throws:

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

writeStatement

protected void writeStatement(Resource subj,
 IRI pred,
 Value obj,
 Resource context,
 boolean canShortenSubject,
 boolean canShortenObject)
                       throws IOException

Overrides:

writeStatement in class TurtleWriter

Throws:

IOException

writeNamespace

protected void writeNamespace(String prefix,
 String name)
                       throws IOException

Overrides:

writeNamespace in class TurtleWriter

Throws:

IOException

writeVersionAnnouncement

protected void writeVersionAnnouncement()
                                 throws RDFHandlerException

Description copied from class: AbstractRDFWriter

Writes the format-specific version directive to the output stream. Called at most once per document, by AbstractRDFWriter.ensureVersionAnnouncement().

Default implementation is a no-op; concrete writers must override this.

Overrides:

writeVersionAnnouncement in class TurtleWriter

Throws:

RDFHandlerException

closeActiveContext

protected void closeActiveContext()
                           throws IOException

Throws:

IOException