Package org.eclipse.rdf4j.rio.turtle
Class TurtleWriter
java.lang.Object
org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter
org.eclipse.rdf4j.rio.turtle.TurtleWriter
- All Implemented Interfaces:
CharSink
,Sink
,RDFHandler
,RDFWriter
- Direct Known Subclasses:
TriGWriter
,TurtleStarWriter
An implementation of the RDFWriter interface that writes RDF documents in Turtle format. The Turtle format is defined
in in this document.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Boolean
protected ParsedIRI
protected Model
private final Object
private long
Size of statement buffer used for pretty printing and blank node inlining.private static final long
private static final IRI
private boolean
protected IRI
protected Resource
private static final int
private ModelFactory
private Boolean
private static final IRI
protected boolean
Flag indicating whether the last written statement has been closed.protected IndentingWriter
private Boolean
Fields inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter
namespaceTable, statementConsumer
-
Constructor Summary
ConstructorsConstructorDescriptionTurtleWriter
(OutputStream out) Creates a new TurtleWriter that will write to the supplied OutputStream.TurtleWriter
(OutputStream out, ParsedIRI baseIRI) Creates a new TurtleWriter that will write to the supplied OutputStream.TurtleWriter
(Writer writer) Creates a new TurtleWriter that will write to the supplied Writer.TurtleWriter
(Writer writer, ParsedIRI baseIRI) Creates a new TurtleWriter that will write to the supplied Writer. -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
canInlineValue
(Model contextData, Value v) private void
private void
closeNestedResources
(Resource subj) protected void
protected void
Consume a statement.void
endRDF()
Signals the end of the RDF data.protected ModelFactory
Gets the RDF format that this RDFWriter uses.Collection
<RioSetting<?>> void
handleComment
(String comment) Handles a comment.private void
handleInlineNode
(Statement st, boolean inlineSubject, boolean inlineObject) private void
handleList
(Statement st, boolean canInlineObjectBNode) 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.private boolean
Checks if the writer is configured such that it needs statement buffering.private boolean
private boolean
Check that the collection started with the supplied subject node is a well-formed RDF Collection.nextSubject
(Model contextData, Set<Resource> processedSubjects) private void
not synchronized, assumes calling method has obtained a lock onbufferLock
.private void
processPredicate
(Model contextData, Resource subject, IRI predicate, Set<Resource> processedSubjects, Set<IRI> processedPredicates) private void
processSubject
(Model contextData, Resource subject, Set<Resource> processedSubjects) void
setModelFactory
(ModelFactory modelFactory) Set aModelFactory
to use for creating internal Models for statement processing/buffering purposes.void
startRDF()
Signals the start of the RDF data.private void
wrapLine
(boolean space) protected void
protected void
writeBNode
(BNode bNode) Deprecated.protected void
writeBNode
(BNode bNode, boolean canShorten) protected void
writeCommentLine
(String line) protected void
writeLiteral
(Literal lit) protected void
writeNamespace
(String prefix, String name) protected void
writePredicate
(IRI predicate) protected void
writeResource
(Resource res) Deprecated.UsewriteResource(Resource, boolean)
instead.protected void
writeResource
(Resource res, boolean canShorten) protected void
writeStatement
(Resource subj, IRI pred, Value obj, Resource context, boolean canShortenSubjectBNode, boolean canShortenObjectBNode) protected void
writeTriple
(Triple triple, boolean canShorten) protected void
writeTripleRDFStar
(Triple triple, boolean canShorten) protected void
protected void
writeValue
(Value val) Deprecated.UsewriteValue(Value, boolean)
instead.protected void
writeValue
(Value val, boolean canShorten) 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
-
Field Details
-
LINE_WRAP
private static final int LINE_WRAP- See Also:
-
DEFAULT_BUFFER_SIZE
private static final long DEFAULT_BUFFER_SIZE- See Also:
-
FIRST
-
REST
-
bufferSize
private long bufferSizeSize of statement buffer used for pretty printing and blank node inlining. Set to Long.MAX_VALUE to buffer everything until the end (necessary when blank node inlining). -
bufferedStatements
-
bufferLock
-
baseIRI
-
writer
-
statementClosed
protected boolean statementClosedFlag indicating whether the last written statement has been closed. -
lastWrittenSubject
-
lastWrittenPredicate
-
stack
-
path
-
xsdStringToPlainLiteral
-
prettyPrint
-
inlineBNodes
private boolean inlineBNodes -
abbreviateNumbers
-
modelFactory
-
-
Constructor Details
-
TurtleWriter
Creates a new TurtleWriter that will write to the supplied OutputStream.- Parameters:
out
- The OutputStream to write the Turtle document to.
-
TurtleWriter
Creates a new TurtleWriter that will write to the supplied OutputStream.- Parameters:
out
- The OutputStream to write the Turtle document to.baseIRI
-
-
TurtleWriter
Creates a new TurtleWriter that will write to the supplied Writer.- Parameters:
writer
- The Writer to write the Turtle document to.
-
TurtleWriter
Creates a new TurtleWriter that will write to the supplied Writer.- Parameters:
writer
- The Writer to write the Turtle document to.baseIRI
-
-
-
Method Details
-
getWriter
Description copied from interface:CharSink
-
getRDFFormat
Description copied from interface:RDFWriter
Gets the RDF format that this RDFWriter uses.- Specified by:
getRDFFormat
in interfaceRDFWriter
-
getSupportedSettings
- Specified by:
getSupportedSettings
in interfaceRDFWriter
- Overrides:
getSupportedSettings
in classAbstractRDFWriter
- Returns:
- A collection of
RioSetting
s that are supported by this RDFWriter.
-
startRDF
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 interfaceRDFHandler
- Overrides:
startRDF
in classAbstractRDFWriter
- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
endRDF
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 interfaceRDFHandler
- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
handleNamespace
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 interfaceRDFHandler
- Overrides:
handleNamespace
in classAbstractRDFWriter
- 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.- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
setModelFactory
Set aModelFactory
to use for creating internal Models for statement processing/buffering purposes.- Parameters:
modelFactory
- aModelFactory
to use for internal buffering / statement processing purposes. May not be null.
-
getModelFactory
-
consumeStatement
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 classAbstractRDFWriter
- Parameters:
st
- the statement to consume.- Throws:
RDFHandlerException
-
handleStatementInternal
protected void handleStatementInternal(Statement st, boolean endRDFCalled, boolean canShortenSubjectBNode, boolean canShortenObjectBNode) Internal method that differentiates between the pretty-print and streaming writer cases.- Parameters:
st
- The next statement to writeendRDFCalled
- True if endRDF has been called before this method is called. This is used to buffer statements for pretty-printing before dumping them when all statements have been delivered to us.canShortenSubjectBNode
- True if, in the current context, we may be able to shorten the subject of this statement iff it is an instance ofBNode
.canShortenObjectBNode
- True if, in the current context, we may be able to shorten the object of this statement iff it is an instance ofBNode
.
-
isWellFormedCollection
Check that the collection started with the supplied subject node is a well-formed RDF Collection.It specifically checks that any collection subject blank nodes (the subjects of the rdf:first and rdf:rest statements) are _not_ reused for any other, unrelated statements, and there are no things like multiple rdf:first or rdf:rest statements for the same subject.
- Returns:
- true if the collection is considered well-formed false otherwise.
-
writeStatement
protected void writeStatement(Resource subj, IRI pred, Value obj, Resource context, boolean canShortenSubjectBNode, boolean canShortenObjectBNode) throws IOException - Throws:
IOException
-
handleComment
Description copied from interface:RDFHandler
Handles a comment.- Specified by:
handleComment
in interfaceRDFHandler
- Parameters:
comment
- The comment.- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
writeCommentLine
- Throws:
IOException
-
writeBase
- Throws:
IOException
-
writeNamespace
- Throws:
IOException
-
writePredicate
- Throws:
IOException
-
writeValue
Deprecated.UsewriteValue(Value, boolean)
instead.- Parameters:
val
- TheValue
to write.- Throws:
IOException
-
writeValue
Writes a value, optionally shortening it if it is anIRI
and has a namespace definition that is suitable for use in this context for shortening or aBNode
that has been confirmed to be able to be shortened in this context.- Parameters:
val
- TheValue
to write.canShorten
- True if, in the current context, we can shorten this value if it is an instance ofBNode
.- Throws:
IOException
-
writeResource
Deprecated.UsewriteResource(Resource, boolean)
instead.- Parameters:
res
- TheResource
to write.- Throws:
IOException
-
writeResource
Writes aResource
, optionally shortening it if it is anIRI
and has a namespace definition that is suitable for use in this context for shortening or aBNode
that has been confirmed to be able to be shortened in this context.- Parameters:
res
- TheResource
to write.canShorten
- True if, in the current context, we can shorten this value if it is an instance ofBNode
.- Throws:
IOException
-
writeURI
- Throws:
IOException
-
writeBNode
Deprecated.UsewriteBNode(BNode, boolean)
instead.- Parameters:
bNode
- TheBNode
to write.- Throws:
IOException
-
writeBNode
- Throws:
IOException
-
writeTriple
- Throws:
IOException
-
writeTripleRDFStar
- Throws:
IOException
-
writeLiteral
- Throws:
IOException
-
closePreviousStatement
- Throws:
IOException
-
isHanging
private boolean isHanging() -
closeHangingResource
- Throws:
IOException
-
closeNestedResources
- Throws:
IOException
-
handleInlineNode
private void handleInlineNode(Statement st, boolean inlineSubject, boolean inlineObject) throws IOException - Throws:
IOException
-
handleList
- Throws:
IOException
-
wrapLine
- Throws:
IOException
-
processBuffer
not synchronized, assumes calling method has obtained a lock onbufferLock
.- Throws:
RDFHandlerException
-
nextSubject
-
processSubject
-
processPredicate
-
canInlineValue
-
isBuffering
private boolean isBuffering()Checks if the writer is configured such that it needs statement buffering.- Returns:
- true if the writer is buffering, false otherwise.
-
writeBNode(BNode, boolean)
instead.