org.openrdf.rio

Class Rio

java.lang.Object

org.openrdf.rio.Rio

public class Rio
extends Object

Static methods for parsing and writing RDF for all available syntaxes.

It includes methods for searching for RDFFormats based on MIME types and file extensions, creating RDFParsers and RDFWriters, and directly parsing and writing.

Author:

Arjohn Kampman, Peter Ansell

Constructor Summary

Constructors

Constructor and Description
Rio()

Method Summary

Modifier and Type	Method and Description
static RDFParser	createParser(RDFFormat format) Convenience methods for creating RDFParser objects.
static RDFParser	createParser(RDFFormat format, ValueFactory valueFactory) Convenience methods for creating RDFParser objects that use the specified ValueFactory to create RDF model objects.
static RDFWriter	createWriter(RDFFormat format, OutputStream out) Convenience methods for creating RDFWriter objects.
static RDFWriter	createWriter(RDFFormat format, Writer writer) Convenience methods for creating RDFWriter objects.
static Optional<RDFFormat>	getParserFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be parsed.
static Optional<RDFFormat>	getParserFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of RDF formats that can be parsed.
static Optional<RDFFormat>	getWriterFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be written.
static Optional<RDFFormat>	getWriterFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of RDF formats that can be written.
static void	main(String[] args)
static Model	parse(InputStream in, String baseURI, RDFFormat dataFormat, ParserConfig settings, ValueFactory valueFactory, ParseErrorListener errors, Resource... contexts) Adds RDF data from an InputStream to a Model, optionally to one or more named contexts.
static Model	parse(InputStream in, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds RDF data from an InputStream to a Model, optionally to one or more named contexts.
static Model	parse(Reader reader, String baseURI, RDFFormat dataFormat, ParserConfig settings, ValueFactory valueFactory, ParseErrorListener errors, Resource... contexts) Adds RDF data from a Reader to a Model, optionally to one or more named contexts.
static Model	parse(Reader reader, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds RDF data from a Reader to a Model, optionally to one or more named contexts.
static java.util.function.Supplier<UnsupportedRDFormatException>	unsupportedFormat(RDFFormat unsupportedFormat) Helper method to use to create a lambda for Optional.orElseThrow(Supplier) to indicate a format is unsupported.
static java.util.function.Supplier<UnsupportedRDFormatException>	unsupportedFormat(String unsupportedFormat) Helper method to use to create a lambda for Optional.orElseThrow(Supplier) to indicate a format is unsupported.
static void	write(Iterable<Statement> model, OutputStream output, RDFFormat dataFormat) Writes the given statements to the given OutputStream in the given format.
static void	write(Iterable<Statement> model, OutputStream output, RDFFormat dataFormat, WriterConfig settings) Writes the given statements to the given OutputStream in the given format.
static void	write(Iterable<Statement> model, RDFHandler writer) Writes the given statements to the given RDFHandler.
static void	write(Iterable<Statement> model, Writer output, RDFFormat dataFormat) Writes the given statements to the given Writer in the given format.
static void	write(Iterable<Statement> model, Writer output, RDFFormat dataFormat, WriterConfig settings) Writes the given statements to the given Writer in the given format.
static void	write(Statement st, OutputStream output, RDFFormat dataFormat) Writes the given statement to the given OutputStream in the given format.
static void	write(Statement st, OutputStream output, RDFFormat dataFormat, WriterConfig settings) Writes the given single statement to the given OutputStream in the given format.
static void	write(Statement statement, RDFHandler writer) Writes the given single statement to the given RDFHandler.
static void	write(Statement statement, Writer output, RDFFormat dataFormat) Writes the given single statement to the given Writer in the given format.
static void	write(Statement statement, Writer output, RDFFormat dataFormat, WriterConfig settings) Writes the given single statement to the given Writer in the given format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rio

public Rio()

Method Detail

getParserFormatForMIMEType

public static Optional<RDFFormat> getParserFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of RDF formats that can be parsed.

Parameters:

mimeType - A MIME type, e.g. "application/rdf+xml".

Returns:

An RDFFormat object if a match was found, or Optional.empty() otherwise.

See Also:

#getParserFormatForMIMEType(String, RDFFormat)

getParserFormatForFileName

public static Optional<RDFFormat> getParserFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be parsed.

Parameters:

fileName - A file name.

Returns:

An RDFFormat object if a match was found, or Optional.empty() otherwise.

See Also:

#getParserFormatForFileName(String, RDFFormat)

getWriterFormatForMIMEType

public static Optional<RDFFormat> getWriterFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of RDF formats that can be written.

Parameters:

mimeType - A MIME type, e.g. "application/rdf+xml".

Returns:

An RDFFormat object if a match was found, or Optional.empty() otherwise.

See Also:

#getWriterFormatForMIMEType(String, RDFFormat)

getWriterFormatForFileName

public static Optional<RDFFormat> getWriterFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be written.

Parameters:

fileName - A file name.

Returns:

An RDFFormat object if a match was found, or Optional.empty() otherwise.

See Also:

#getWriterFormatForFileName(String, RDFFormat)

createParser

public static RDFParser createParser(RDFFormat format)
                              throws UnsupportedRDFormatException

Convenience methods for creating RDFParser objects. This method uses the registry returned by RDFParserRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate parser.

Throws:

UnsupportedRDFormatException - If no parser is available for the specified RDF format.

createParser

public static RDFParser createParser(RDFFormat format,
                                     ValueFactory valueFactory)
                              throws UnsupportedRDFormatException

Convenience methods for creating RDFParser objects that use the specified ValueFactory to create RDF model objects.

Throws:

UnsupportedRDFormatException - If no parser is available for the specified RDF format.

See Also:

createParser(RDFFormat), RDFParser.setValueFactory(ValueFactory)

createWriter

public static RDFWriter createWriter(RDFFormat format,
                                     OutputStream out)
                              throws UnsupportedRDFormatException

Convenience methods for creating RDFWriter objects. This method uses the registry returned by 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.

createWriter

public static RDFWriter createWriter(RDFFormat format,
                                     Writer writer)
                              throws UnsupportedRDFormatException

Convenience methods for creating RDFWriter objects. This method uses the registry returned by 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.

parse

public static Model parse(InputStream in,
                          String baseURI,
                          RDFFormat dataFormat,
                          Resource... contexts)
                   throws IOException,
                          RDFParseException,
                          UnsupportedRDFormatException

Adds RDF data from an InputStream to a Model, optionally to one or more named contexts.

Parameters:

in - An InputStream from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

contexts - The contexts to add the data to. If one or more contexts are supplied the method ignores contextual information in the actual data. If no contexts are supplied the contextual information in the input stream is used, if no context information is available the data is added without any context.

Returns:

A Model containing the parsed statements.

Throws:

IOException - If an I/O error occurred while reading from the input stream.

UnsupportedRDFormatException - If no RDFParser is available for the specified RDF format.

RDFParseException - If an error was found while parsing the RDF data.

Since:

2.7.1

parse

public static Model parse(Reader reader,
                          String baseURI,
                          RDFFormat dataFormat,
                          Resource... contexts)
                   throws IOException,
                          RDFParseException,
                          UnsupportedRDFormatException

Adds RDF data from a Reader to a Model, optionally to one or more named contexts. Note: using a Reader to upload byte-based data means that you have to be careful not to destroy the data's character encoding by enforcing a default character encoding upon the bytes. If possible, adding such data using an InputStream is to be preferred.

Parameters:

reader - A Reader from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

contexts - The contexts to add the data to. If one or more contexts are specified the data is added to these contexts, ignoring any context information in the data itself.

Returns:

A Model containing the parsed statements.

Throws:

IOException - If an I/O error occurred while reading from the reader.

UnsupportedRDFormatException - If no RDFParser is available for the specified RDF format.

RDFParseException - If an error was found while parsing the RDF data.

Since:

2.7.1

parse

public static Model parse(InputStream in,
                          String baseURI,
                          RDFFormat dataFormat,
                          ParserConfig settings,
                          ValueFactory valueFactory,
                          ParseErrorListener errors,
                          Resource... contexts)
                   throws IOException,
                          RDFParseException,
                          UnsupportedRDFormatException

Adds RDF data from an InputStream to a Model, optionally to one or more named contexts.

Parameters:

in - An InputStream from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

settings - The ParserConfig containing settings for configuring the parser.

valueFactory - The ValueFactory used by the parser to create statements.

errors - The ParseErrorListener used by the parser to signal errors, including errors that do not generate an RDFParseException.

contexts - The contexts to add the data to. If one or more contexts are supplied the method ignores contextual information in the actual data. If no contexts are supplied the contextual information in the input stream is used, if no context information is available the data is added without any context.

Returns:

A Model containing the parsed statements.

Throws:

IOException - If an I/O error occurred while reading from the input stream.

UnsupportedRDFormatException - If no RDFParser is available for the specified RDF format.

RDFParseException - If an error was found while parsing the RDF data.

Since:

2.7.3

parse

public static Model parse(Reader reader,
                          String baseURI,
                          RDFFormat dataFormat,
                          ParserConfig settings,
                          ValueFactory valueFactory,
                          ParseErrorListener errors,
                          Resource... contexts)
                   throws IOException,
                          RDFParseException,
                          UnsupportedRDFormatException

Adds RDF data from a Reader to a Model, optionally to one or more named contexts. Note: using a Reader to upload byte-based data means that you have to be careful not to destroy the data's character encoding by enforcing a default character encoding upon the bytes. If possible, adding such data using an InputStream is to be preferred.

Parameters:

reader - A Reader from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

settings - The ParserConfig containing settings for configuring the parser.

valueFactory - The ValueFactory used by the parser to create statements.

errors - The ParseErrorListener used by the parser to signal errors, including errors that do not generate an RDFParseException.

contexts - The contexts to add the data to. If one or more contexts are specified the data is added to these contexts, ignoring any context information in the data itself.

Returns:

A Model containing the parsed statements.

Throws:

IOException - If an I/O error occurred while reading from the reader.

UnsupportedRDFormatException - If no RDFParser is available for the specified RDF format.

RDFParseException - If an error was found while parsing the RDF data.

Since:

2.7.3

write

public static void write(Iterable<Statement> model,
                         OutputStream output,
                         RDFFormat dataFormat)
                  throws RDFHandlerException

Writes the given statements to the given OutputStream in the given format.

If the collection is a Model, its namespaces will also be written.

Parameters:

model - A collection of statements, such as a Model, to be written.

output - The OutputStream to write the statements to.

dataFormat - The RDFFormat to use when writing the statements.

Throws:

RDFHandlerException - Thrown if there is an error writing the statements.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.7.1

write

public static void write(Iterable<Statement> model,
                         Writer output,
                         RDFFormat dataFormat)
                  throws RDFHandlerException

Writes the given statements to the given Writer in the given format.

If the collection is a Model, its namespaces will also be written.

Parameters:

model - A collection of statements, such as a Model, to be written.

output - The Writer to write the statements to.

dataFormat - The RDFFormat to use when writing the statements.

Throws:

RDFHandlerException - Thrown if there is an error writing the statements.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.7.1

write

public static void write(Iterable<Statement> model,
                         OutputStream output,
                         RDFFormat dataFormat,
                         WriterConfig settings)
                  throws RDFHandlerException

Writes the given statements to the given OutputStream in the given format.

If the collection is a Model, its namespaces will also be written.

Parameters:

model - A collection of statements, such as a Model, to be written.

output - The OutputStream to write the statements to.

dataFormat - The RDFFormat to use when writing the statements.

settings - The WriterConfig containing settings for configuring the writer.

Throws:

RDFHandlerException - Thrown if there is an error writing the statements.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.7.3

write

public static void write(Iterable<Statement> model,
                         Writer output,
                         RDFFormat dataFormat,
                         WriterConfig settings)
                  throws RDFHandlerException

Writes the given statements to the given Writer in the given format.

If the collection is a Model, its namespaces will also be written.

Parameters:

model - A collection of statements, such as a Model, to be written.

output - The Writer to write the statements to.

dataFormat - The RDFFormat to use when writing the statements.

settings - The WriterConfig containing settings for configuring the writer.

Throws:

RDFHandlerException - Thrown if there is an error writing the statements.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.7.3

write

public static void write(Iterable<Statement> model,
                         RDFHandler writer)
                  throws RDFHandlerException

Writes the given statements to the given RDFHandler.

If the collection is a Model, its namespaces will also be written.

Parameters:

model - A collection of statements, such as a Model, to be written.

Throws:

RDFHandlerException - Thrown if there is an error writing the statements.

Since:

2.7.3

write

public static void write(Statement st,
                         OutputStream output,
                         RDFFormat dataFormat)
                  throws RDFHandlerException

Writes the given statement to the given OutputStream in the given format.

Parameters:

st - The statement to be written.

output - The OutputStream to write the statement to.

dataFormat - The RDFFormat to use when writing the statement.

Throws:

RDFHandlerException - Thrown if there is an error writing the statement.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.8.0

write

public static void write(Statement st,
                         OutputStream output,
                         RDFFormat dataFormat,
                         WriterConfig settings)
                  throws RDFHandlerException

Writes the given single statement to the given OutputStream in the given format.

Parameters:

st - The statement to be written.

output - The OutputStream to write the statement to.

dataFormat - The RDFFormat to use when writing the statement.

settings - The WriterConfig containing setting for configuring the writer.

Throws:

RDFHandlerException - Thrown if there is an error writing the statement.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.8.0

write

public static void write(Statement statement,
                         Writer output,
                         RDFFormat dataFormat)
                  throws RDFHandlerException

Writes the given single statement to the given Writer in the given format.

Parameters:

statement - A statement to be written.

output - The Writer to write the statement to.

dataFormat - The RDFFormat to use when writing the statement.

Throws:

RDFHandlerException - Thrown if there is an error writing the statement.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.8.0

write

public static void write(Statement statement,
                         Writer output,
                         RDFFormat dataFormat,
                         WriterConfig settings)
                  throws RDFHandlerException

Writes the given single statement to the given Writer in the given format.

Parameters:

statement - A statement to be written.

output - The Writer to write the statement to.

dataFormat - The RDFFormat to use when writing the statement.

settings - The WriterConfig containing settings for configuring the writer.

Throws:

RDFHandlerException - Thrown if there is an error writing the statement.

UnsupportedRDFormatException - If no RDFWriter is available for the specified RDF format.

Since:

2.8.0

write

public static void write(Statement statement,
                         RDFHandler writer)
                  throws RDFHandlerException

Writes the given single statement to the given RDFHandler.

Parameters:

statement - A statement, to be written.

Throws:

RDFHandlerException - Thrown if there is an error writing the statement.

Since:

2.8.0

main

public static void main(String[] args)
                 throws IOException,
                        RDFParseException,
                        RDFHandlerException,
                        UnsupportedRDFormatException

Throws:

IOException

RDFParseException

RDFHandlerException

UnsupportedRDFormatException

unsupportedFormat

public static java.util.function.Supplier<UnsupportedRDFormatException> unsupportedFormat(RDFFormat unsupportedFormat)

Helper method to use to create a lambda for Optional.orElseThrow(Supplier) to indicate a format is unsupported.

Parameters:

unsupportedFormat - The format that was not found.

Returns:

A lambda that can be used to generate an exception if the format is not found.

unsupportedFormat

public static java.util.function.Supplier<UnsupportedRDFormatException> unsupportedFormat(String unsupportedFormat)

Helper method to use to create a lambda for Optional.orElseThrow(Supplier) to indicate a format is unsupported.

Parameters:

unsupportedFormat - The format that was not found.

Returns:

A lambda that can be used to generate an exception if the format is not found.