Package com.stardog.stark.io.turtle

Class PrettyTurtleWriter

java.lang.Object

com.stardog.stark.io.turtle.TurtleWriter

com.stardog.stark.io.turtle.PrettyTurtleWriter

All Implemented Interfaces:

RDFHandler, RDFWriter

public class PrettyTurtleWriter
extends TurtleWriter
implements RDFWriter

An Turtle writer that abbreviates bnodes and lists. This writer requires to buffer all the triples in memory before writing so no output will be printed until end() is called. If the number of triples exceed a limit, the writer prints them as TurtleWriter, i.e. without bnode and list shortcuts.

Since:

1.0

Version:

1.0

Author:

Michael Grove

Implementation Notes:

Comments are not supported with this writer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrettyTurtleWriter.PrettyTurtleWriterFactory

Nested classes/interfaces inherited from class com.stardog.stark.io.turtle.TurtleWriter

TurtleWriter.TurtleWriterFactory

Field Summary

Fields inherited from class com.stardog.stark.io.turtle.TurtleWriter

mBlockSpec, mLastWrittenPredicate, mLastWrittenSubject, mNamespaces, mOptions, mStarted, mStmtClosed, mWriter

Constructor Summary

Constructors

Constructor	Description
PrettyTurtleWriter(java.io.OutputStream theWriter, Options theOptions)

Method Summary

Modifier and Type	Method	Description
void	comment(java.lang.String theComment)	Write a comment to the output.
void	end()	Signals the writing process is completed.
RDFFormat	format()	The format this writer will serialize output in.
void	handle(Statement theStmt)	Write the given Statement
void	namespace(java.lang.String thePrefix, java.lang.String theIRI)	Provide a namespace to the writer.
void	start()	Signals that the RDF writing process is starting.

Methods inherited from class com.stardog.stark.io.turtle.TurtleWriter

closePreviousStatement, writeBNode, writeCommentLine, writeEmbeddedTriple, writeIRI, writeLiteral, writeNamespace, writePredicate, writeResource, writeValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyTurtleWriter

public PrettyTurtleWriter(java.io.OutputStream theWriter,
                          Options theOptions)

Method Detail

start

public void start()

Signals that the RDF writing process is starting.

Specified by:

start in interface RDFHandler

Specified by:

start in interface RDFWriter

Overrides:

start in class TurtleWriter

handle

public void handle(@Nonnull
                   Statement theStmt)

Write the given Statement

Specified by:

handle in interface RDFHandler

Specified by:

handle in interface RDFWriter

Overrides:

handle in class TurtleWriter

Parameters:

theStmt - the statement to write

end

public void end()

Signals the writing process is completed. The underlying InputStream is *not* closed, but the caller should not call additional methods on this writer as that will normally yield syntax errors in the output.

Specified by:

end in interface RDFHandler

Specified by:

end in interface RDFWriter

Overrides:

end in class TurtleWriter

comment

public void comment(@Nonnull
                    java.lang.String theComment)

Write a comment to the output. Writing need not be started at this point; comments can be written prior to any actual serialized RDF

Specified by:

comment in interface RDFWriter

Overrides:

comment in class TurtleWriter

Parameters:

theComment - the comment to write

namespace

public void namespace(@Nonnull
                      java.lang.String thePrefix,
                      @Nonnull
                      java.lang.String theIRI)

Description copied from class: TurtleWriter

Provide a namespace to the writer. This method can be called before writing has started, in which case, the namespace bindings are buffered and written when appropriate after writing has begun.

Specified by:

namespace in interface RDFHandler

Specified by:

namespace in interface RDFWriter

Overrides:

namespace in class TurtleWriter

Parameters:

thePrefix - the namespace prefix

theIRI - the associated IRI

format

@Nonnull
public RDFFormat format()

The format this writer will serialize output in.

Specified by:

format in interface RDFWriter

Overrides:

format in class TurtleWriter

Returns:

the format