Merge pull request #877 from jamesrdf/issues/#876-base-directive

Fix #876: Add BASE_DIRECTIVE writer config and baseURI parameter to writer interface

Author: James Leigh

core/rio/api/src/main/java/org/eclipse/rdf4j/rio/RDFWriterFactory.java

@@ -9,6 +9,7 @@
 
 import java.io.OutputStream;
 import java.io.Writer;
+import java.net.URISyntaxException;
 
 /**
  * A RDFWriterFactory returns {@link RDFWriter}s for a specific RDF format.
@@ -30,6 +31,19 @@ public interface RDFWriterFactory {
 	 */
 	public RDFWriter getWriter(OutputStream out);
 
+	/**
+	 * Returns an RDFWriter instance that will write to the supplied output stream. Using the supplied baseURI
+	 * to relativize IRIs to relative IRIs.
+	 *
+	 * @param out
+	 *        The OutputStream to write the RDF to.
+	 * @param baseURI
+	 *        The URI associated with the data in the InputStream.
+	 * @throws URISyntaxException
+	 */
+	public RDFWriter getWriter(OutputStream out, String baseURI)
+		throws URISyntaxException;
+
 	/**
 	 * Returns an RDFWriter instance that will write to the supplied writer. (Optional operation)
 	 * 
@@ -39,4 +53,19 @@ public interface RDFWriterFactory {
 	 *         if the RDFWriter the specific format does not support writing to a {@link java.io.Writer}
 	 */
 	public RDFWriter getWriter(Writer writer);
+
+	/**
+	 * Returns an RDFWriter instance that will write to the supplied writer. Using the supplied baseURI to
+	 * relativize IRIs to relative IRIs. (Optional operation)
+	 *
+	 * @param writer
+	 *        The Writer to write the RDF to.
+	 * @param baseURI
+	 *        The URI associated with the data in the InputStream.
+	 * @throws URISyntaxException
+	 * @throws UnsupportedOperationException
+	 *         if the RDFWriter the specific format does not support writing to a {@link java.io.Writer}
+	 */
+	public RDFWriter getWriter(Writer writer, String baseURI)
+		throws URISyntaxException;
 }

core/rio/api/src/main/java/org/eclipse/rdf4j/rio/Rio.java

@@ -14,6 +14,7 @@
 import java.io.OutputStream;
 import java.io.Reader;
 import java.io.Writer;
+import java.net.URISyntaxException;
 import java.util.Optional;
 import java.util.function.Supplier;
 
@@ -138,6 +139,26 @@ public static RDFWriter createWriter(RDFFormat format, OutputStream out)
 		return factory.getWriter(out);
 	}
 
+	/**
+	 * Convenience methods for creating RDFWriter objects. This method uses the registry returned by
+	 * {@link RDFWriterRegistry#getInstance()} to get a factory for the specified format and uses this factory
+	 * to create the appropriate writer.
+	 * 
+	 * @throws UnsupportedRDFormatException
+	 *         If no writer is available for the specified RDF format.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid
+	 */
+	public static RDFWriter createWriter(RDFFormat format, OutputStream out, String baseURI)
+		throws UnsupportedRDFormatException,
+		URISyntaxException
+	{
+		RDFWriterFactory factory = RDFWriterRegistry.getInstance().get(format).orElseThrow(
+				Rio.unsupportedFormat(format));
+
+		return factory.getWriter(out, baseURI);
+	}
+
 	/**
 	 * Convenience methods for creating RDFWriter objects. This method uses the registry returned by
 	 * {@link RDFWriterRegistry#getInstance()} to get a factory for the specified format and uses this factory
@@ -155,6 +176,26 @@ public static RDFWriter createWriter(RDFFormat format, Writer writer)
 		return factory.getWriter(writer);
 	}
 
+	/**
+	 * Convenience methods for creating RDFWriter objects. This method uses the registry returned by
+	 * {@link RDFWriterRegistry#getInstance()} to get a factory for the specified format and uses this factory
+	 * to create the appropriate writer.
+	 * 
+	 * @throws UnsupportedRDFormatException
+	 *         If no writer is available for the specified RDF format.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid
+	 */
+	public static RDFWriter createWriter(RDFFormat format, Writer writer, String baseURI)
+		throws UnsupportedRDFormatException,
+		URISyntaxException
+	{
+		RDFWriterFactory factory = RDFWriterRegistry.getInstance().get(format).orElseThrow(
+				Rio.unsupportedFormat(format));
+
+		return factory.getWriter(writer, baseURI);
+	}
+
 	/**
 	 * Adds RDF data from an {@link InputStream} to a {@link Model}, optionally to one or more named contexts.
 	 * 
@@ -325,6 +366,33 @@ public static void write(Iterable<Statement> model, OutputStream output, RDFForm
 		write(model, output, dataFormat, new WriterConfig());
 	}
 
+	/**
+	 * Writes the given statements to the given {@link OutputStream} in the given format.
+	 * <p>
+	 * If the collection is a {@link Model}, its namespaces will also be written.
+	 * 
+	 * @param model
+	 *        A collection of statements, such as a {@link Model}, to be written.
+	 * @param output
+	 *        The {@link OutputStream} to write the statements to.
+	 * @param baseURI
+	 *        The base URI to relativize IRIs against.
+	 * @param dataFormat
+	 *        The {@link RDFFormat} to use when writing the statements.
+	 * @throws RDFHandlerException
+	 *         Thrown if there is an error writing the statements.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid 
+	 * @throws UnsupportedRDFormatException
+	 *         If no {@link RDFWriter} is available for the specified RDF format.
+	 */
+	public static void write(Iterable<Statement> model, OutputStream output, String baseURI,
+			RDFFormat dataFormat)
+		throws RDFHandlerException, UnsupportedRDFormatException, URISyntaxException
+	{
+		write(model, output, baseURI, dataFormat, new WriterConfig());
+	}
+
 	/**
 	 * Writes the given statements to the given {@link Writer} in the given format.
 	 * <p>
@@ -347,6 +415,32 @@ public static void write(Iterable<Statement> model, Writer output, RDFFormat dat
 		write(model, output, dataFormat, new WriterConfig());
 	}
 
+	/**
+	 * Writes the given statements to the given {@link Writer} in the given format.
+	 * <p>
+	 * If the collection is a {@link Model}, its namespaces will also be written.
+	 * 
+	 * @param model
+	 *        A collection of statements, such as a {@link Model}, to be written.
+	 * @param output
+	 *        The {@link Writer} to write the statements to.
+	 * @param baseURI
+	 *        The base URI to relativize IRIs against.
+	 * @param dataFormat
+	 *        The {@link RDFFormat} to use when writing the statements.
+	 * @throws RDFHandlerException
+	 *         Thrown if there is an error writing the statements.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid
+	 * @throws UnsupportedRDFormatException
+	 *         If no {@link RDFWriter} is available for the specified RDF format.
+	 */
+	public static void write(Iterable<Statement> model, Writer output, String baseURI, RDFFormat dataFormat)
+		throws RDFHandlerException, UnsupportedRDFormatException, URISyntaxException
+	{
+		write(model, output, baseURI, dataFormat, new WriterConfig());
+	}
+
 	/**
 	 * Writes the given statements to the given {@link OutputStream} in the given format.
 	 * <p>
@@ -374,6 +468,37 @@ public static void write(Iterable<Statement> model, OutputStream output, RDFForm
 		write(model, writer);
 	}
 
+	/**
+	 * Writes the given statements to the given {@link OutputStream} in the given format.
+	 * <p>
+	 * If the collection is a {@link Model}, its namespaces will also be written.
+	 * 
+	 * @param model
+	 *        A collection of statements, such as a {@link Model}, to be written.
+	 * @param output
+	 *        The {@link OutputStream} to write the statements to.
+	 * @param baseURI
+	 *        The base URI to relativize IRIs against.
+	 * @param dataFormat
+	 *        The {@link RDFFormat} to use when writing the statements.
+	 * @param settings
+	 *        The {@link WriterConfig} containing settings for configuring the writer.
+	 * @throws RDFHandlerException
+	 *         Thrown if there is an error writing the statements.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid
+	 * @throws UnsupportedRDFormatException
+	 *         If no {@link RDFWriter} is available for the specified RDF format.
+	 */
+	public static void write(Iterable<Statement> model, OutputStream output, String baseURI,
+			RDFFormat dataFormat, WriterConfig settings)
+		throws RDFHandlerException, UnsupportedRDFormatException, URISyntaxException
+	{
+		final RDFWriter writer = Rio.createWriter(dataFormat, output, baseURI);
+		writer.setWriterConfig(settings);
+		write(model, writer);
+	}
+
 	/**
 	 * Writes the given statements to the given {@link Writer} in the given format.
 	 * <p>
@@ -401,6 +526,37 @@ public static void write(Iterable<Statement> model, Writer output, RDFFormat dat
 		write(model, writer);
 	}
 
+	/**
+	 * Writes the given statements to the given {@link Writer} in the given format.
+	 * <p>
+	 * If the collection is a {@link Model}, its namespaces will also be written.
+	 * 
+	 * @param model
+	 *        A collection of statements, such as a {@link Model}, to be written.
+	 * @param output
+	 *        The {@link Writer} to write the statements to.
+	 * @param baseURI
+	 *        The base URI to relativize IRIs against.
+	 * @param dataFormat
+	 *        The {@link RDFFormat} to use when writing the statements.
+	 * @param settings
+	 *        The {@link WriterConfig} containing settings for configuring the writer.
+	 * @throws RDFHandlerException
+	 *         Thrown if there is an error writing the statements.
+	 * @throws URISyntaxException
+	 *         If the baseURI is invalid
+	 * @throws UnsupportedRDFormatException
+	 *         If no {@link RDFWriter} is available for the specified RDF format.
+	 */
+	public static void write(Iterable<Statement> model, Writer output, String baseURI, RDFFormat dataFormat,
+			WriterConfig settings)
+		throws RDFHandlerException, UnsupportedRDFormatException, URISyntaxException
+	{
+		final RDFWriter writer = Rio.createWriter(dataFormat, output, baseURI);
+		writer.setWriterConfig(settings);
+		write(model, writer);
+	}
+
 	/**
 	 * Writes the given statements to the given {@link RDFHandler}.
 	 * <p>

core/rio/api/src/main/java/org/eclipse/rdf4j/rio/helpers/BasicWriterSettings.java

@@ -56,6 +56,14 @@ public class BasicWriterSettings {
 			"org.eclipse.rdf4j.rio.rdf10languageliterals", "RDF-1.0 compatible Language Literals",
 			Boolean.TRUE);
 
+	/**
+	 * Boolean setting for writer to determine whether it should include a base directive.
+	 * <p>
+	 * Defaults to true
+	 */
+	public static final RioSetting<Boolean> BASE_DIRECTIVE = new RioSettingImpl<Boolean>(
+			"org.eclipse.rdf4j.rio.basedirective", "Serialize base directive", Boolean.TRUE);
+
 	/**
 	 * Private default constructor.
 	 */

core/rio/binary/src/main/java/org/eclipse/rdf4j/rio/binary/BinaryRDFWriterFactory.java

@@ -35,10 +35,21 @@ public RDFWriter getWriter(OutputStream out) {
 		return new BinaryRDFWriter(out);
 	}
 
+	public RDFWriter getWriter(OutputStream out, String baseURI) {
+		return new BinaryRDFWriter(out);
+	}
+
 	/**
-	 * Returns a new instance of {@link BinaryRDFWriter}.
+	 * throws UnsupportedOperationException
 	 */
 	public RDFWriter getWriter(Writer writer) {
 		throw new UnsupportedOperationException();
 	}
+
+	/**
+	 * throws UnsupportedOperationException
+	 */
+	public RDFWriter getWriter(Writer writer, String baseURI) {
+		throw new UnsupportedOperationException();
+	}
 }

core/rio/jsonld/src/main/java/org/eclipse/rdf4j/rio/jsonld/JSONLDWriter.java

@@ -49,6 +49,8 @@ public class JSONLDWriter extends AbstractRDFWriter implements RDFWriter {
 
 	private final StatementCollector statementCollector = new StatementCollector(model);
 
+	private final String baseURI;
+
 	private final Writer writer;
 
 	/**
@@ -58,7 +60,17 @@ public class JSONLDWriter extends AbstractRDFWriter implements RDFWriter {
 	 *        The OutputStream to write to.
 	 */
 	public JSONLDWriter(OutputStream outputStream) {
-		this(new BufferedWriter(new OutputStreamWriter(outputStream, Charset.forName("UTF-8"))));
+		this(outputStream, null);
+	}
+
+	/**
+	 * Create a SesameJSONLDWriter using a {@link java.io.OutputStream}
+	 *
+	 * @param outputStream
+	 *        The OutputStream to write to.
+	 */
+	public JSONLDWriter(OutputStream outputStream, String baseURI) {
+		this(new BufferedWriter(new OutputStreamWriter(outputStream, Charset.forName("UTF-8"))), baseURI);
 	}
 
 	/**
@@ -68,6 +80,17 @@ public JSONLDWriter(OutputStream outputStream) {
 	 *        The Writer to write to.
 	 */
 	public JSONLDWriter(Writer writer) {
+		this(writer, null);
+	}
+
+	/**
+	 * Create a SesameJSONLDWriter using a {@link java.io.Writer}
+	 *
+	 * @param writer
+	 *        The Writer to write to.
+	 */
+	public JSONLDWriter(Writer writer, String baseURI) {
+		this.baseURI = baseURI;
 		this.writer = writer;
 	}
 
@@ -103,6 +126,9 @@ public void endRDF()
 			opts.setUseNativeTypes(getWriterConfig().get(JSONLDSettings.USE_NATIVE_TYPES));
 			// opts.optimize = getWriterConfig().get(JSONLDSettings.OPTIMIZE);
 
+			if (baseURI != null && getWriterConfig().get(BasicWriterSettings.BASE_DIRECTIVE)) {
+				opts.setBase(baseURI);
+			}
 			if (mode == JSONLDMode.EXPAND) {
 				output = JsonLdProcessor.expand(output, opts);
 			}

core/rio/jsonld/src/main/java/org/eclipse/rdf4j/rio/jsonld/JSONLDWriterFactory.java

@@ -31,9 +31,19 @@ public RDFWriter getWriter(OutputStream out) {
 		return new JSONLDWriter(out);
 	}
 
+	@Override
+	public RDFWriter getWriter(OutputStream out, String baseURI) {
+		return new JSONLDWriter(out, baseURI);
+	}
+
 	@Override
 	public RDFWriter getWriter(Writer writer) {
 		return new JSONLDWriter(writer);
 	}
 
+	@Override
+	public RDFWriter getWriter(Writer writer, String baseURI) {
+		return new JSONLDWriter(writer, baseURI);
+	}
+
 }