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
RDFWriters offering common functionality for RDF writers.- Author:
- Peter Ansell
-
Field Summary
FieldsModifier and TypeFieldDescriptionMapping from namespace prefixes to namespace names. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidVerify that writing has started.protected voidConsume a statement.Get theFileFormatthis sink uses.Collection<RioSetting<?>>Retrieves the current writer configuration as a single object.voidhandleNamespace(String prefix, String uri) Handles a namespace declaration/definition.voidHandles a statement.protected booleanSee if writing has started<T> RDFWriterset(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.voidstartRDF()Signals the start of the RDF data.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.rdf4j.rio.RDFHandler
endRDF, handleCommentMethods inherited from interface org.eclipse.rdf4j.rio.RDFWriter
getRDFFormatMethods inherited from interface org.eclipse.rdf4j.common.io.Sink
acceptsFileFormat
-
Field Details
-
namespaceTable
Mapping from namespace prefixes to namespace names. -
statementConsumer
-
-
Constructor Details
-
AbstractRDFWriter
public AbstractRDFWriter()
-
-
Method Details
-
handleNamespace
Description copied from interface:RDFHandlerHandles 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:
handleNamespacein 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:RDFWriterSets all supplied writer configuration options.- Specified by:
setWriterConfigin 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:RDFWriterRetrieves the current writer configuration as a single object.- Specified by:
getWriterConfigin interfaceRDFWriter- Returns:
- a writer configuration object representing the current configuration of the writer.
-
getFileFormat
Description copied from interface:SinkGet theFileFormatthis sink uses.- Specified by:
getFileFormatin interfaceSink- Returns:
- a
FileFormat. May not benull.
-
getSupportedSettings
- Specified by:
getSupportedSettingsin interfaceRDFWriter- Returns:
- A collection of
RioSettings that are supported by this RDFWriter.
-
set
Description copied from interface:RDFWriterSet a setting on the writer, and return this writer object to allow chaining. -
startRDF
Description copied from interface:RDFHandlerSignals the start of the RDF data. This method is called before any data is reported.- Specified by:
startRDFin interfaceRDFHandler- Throws:
RDFHandlerException- If the RDF handler has encountered an unrecoverable error.
-
handleStatement
Description copied from interface:RDFHandlerHandles a statement.- Specified by:
handleStatementin 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:
trueif writing has started,falseotherwise
-
checkWritingStarted
protected void checkWritingStarted()Verify that writing has started.- Throws:
RDFHandlerException- if writing has not yet started.
-