Package org.eclipse.rdf4j.rio.helpers
Class AbstractRDFWriter
java.lang.Object
org.eclipse.rdf4j.rio.helpers.AbstractRDFWriter
- All Implemented Interfaces:
Sink
,RDFHandler
,RDFWriter
- Direct Known Subclasses:
BinaryRDFWriter
,ConsoleRDFWriter
,JSONLDWriter
,JSONLDWriter
,NDJSONLDWriter
,NDJSONLDWriter
,NTriplesWriter
,RDFJSONWriter
,RDFXMLWriter
,TriXWriter
,TurtleWriter
Base class for
RDFWriter
s offering common functionality for RDF writers.- Author:
- Peter Ansell
-
Field Summary
Modifier and TypeFieldDescriptionMapping from namespace prefixes to namespace names. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
Verify that writing has started.protected void
Consume a statement.Get theFileFormat
this sink uses.Collection
<RioSetting<?>> Retrieves the current writer configuration as a single object.void
handleNamespace
(String prefix, String uri) Handles a namespace declaration/definition.void
Handles a statement.protected boolean
See if writing has started<T> RDFWriter
set
(RioSetting<T> setting, T value) Set a setting on the writer, and return this writer object to allow chaining.setWriterConfig
(WriterConfig config) Sets all supplied writer configuration options.void
startRDF()
Signals the start of the RDF data.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.rio.RDFHandler
endRDF, handleComment
Methods inherited from interface org.eclipse.rdf4j.rio.RDFWriter
getRDFFormat
Methods inherited from interface org.eclipse.rdf4j.common.io.Sink
acceptsFileFormat
-
Field Details
-
namespaceTable
-
statementConsumer
-
-
Constructor Details
-
AbstractRDFWriter
public AbstractRDFWriter()
-
-
Method Details
-
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
- 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.
-
setWriterConfig
Description copied from interface:RDFWriter
Sets all supplied writer configuration options.- Specified by:
setWriterConfig
in interfaceRDFWriter
- Parameters:
config
- a writer configuration object.- Returns:
- Either a copy of this writer, if it is immutable, or this object, to allow chaining of method calls.
-
getWriterConfig
Description copied from interface:RDFWriter
Retrieves the current writer configuration as a single object.- Specified by:
getWriterConfig
in interfaceRDFWriter
- Returns:
- a writer configuration object representing the current configuration of the writer.
-
getFileFormat
Description copied from interface:Sink
Get theFileFormat
this sink uses.- Specified by:
getFileFormat
in interfaceSink
- Returns:
- a
FileFormat
. May not benull
.
-
getSupportedSettings
- Specified by:
getSupportedSettings
in interfaceRDFWriter
- Returns:
- A collection of
RioSetting
s that are supported by this RDFWriter.
-
set
Description copied from interface:RDFWriter
Set a setting on the writer, and return this writer object to allow chaining. -
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
- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
handleStatement
Description copied from interface:RDFHandler
Handles a statement.- Specified by:
handleStatement
in interfaceRDFHandler
- Parameters:
st
- The statement.- Throws:
RDFHandlerException
- If the RDF handler has encountered an unrecoverable error.
-
consumeStatement
Consume a statement.Extending classes must override this method instead of overriding
handleStatement(Statement)
in order to benefit from automatic handling of RDF-star conversion or encoding.- Parameters:
st
- the statement to consume.
-
isWritingStarted
protected boolean isWritingStarted()See if writing has started- Returns:
true
if writing has started,false
otherwise
-
checkWritingStarted
protected void checkWritingStarted()Verify that writing has started.- Throws:
RDFHandlerException
- if writing has not yet started.
-