Soprano::Parser Class Reference

Soprano::Parser defines the interface for a Soprano RDF parser plugin. More...

#include <Soprano/Parser>

Inheritance diagram for Soprano::Parser:

[legend]

List of all members.

Public Member Functions
virtual	~Parser ()
virtual RdfSerializations	supportedSerializations () const =0
virtual QStringList	supportedUserSerializations () const
bool	supportsSerialization (RdfSerialization s, const QString &userSerialization=QString()) const
virtual StatementIterator	parseFile (const QString &filename, const QUrl &baseUri, RdfSerialization serialization, const QString &userSerialization=QString()) const
virtual StatementIterator	parseString (const QString &data, const QUrl &baseUri, RdfSerialization serialization, const QString &userSerialization=QString()) const
virtual StatementIterator	parseStream (QTextStream &stream, const QUrl &baseUri, RdfSerialization serialization, const QString &userSerialization=QString()) const =0
Protected Member Functions
	Parser (const QString &name)

---

Detailed Description

Soprano::Parser defines the interface for a Soprano RDF parser plugin.

Each parser plugin may support multiple RDF serializations (supportedSerializations()).

Usage

Using a Parser is straightforward. One starts by getting a plugin that supports the requested RDF data serialization:

 Soprano::Parser* p = Soprano::PluginManager::instance()->discoverParserForSerialization( Soprano::SerializationRdfXml );

Then parsing RDF data is done in a single method call resulting in a StatementIterator over the resulting graph (since parsers may support multiple serializations one always needs to provide the serialization type unless a parser plugin support autodetection).

 Soprano::StatementIterator it = p->parseFile( "myrdffile.rdf", Soprano::SerializationRdfXml );

See also:

Writing Soprano Plugins

Author:

Daniele Galdi <daniele.galdi@gmail.com>
Sebastian Trueg <trueg@kde.org>

Definition at line 69 of file parser.h.

---

Constructor & Destructor Documentation

virtual Soprano::Parser::~Parser

(

)

[virtual]

Soprano::Parser::Parser

(

const QString &

name

)

[protected]

---

Member Function Documentation

virtual RdfSerializations Soprano::Parser::supportedSerializations

(

)

const [pure virtual]

The serialiazation types supported by this parser.

Returns:

A combination of Soprano::RdfSerialization types. If the list contains Soprano::SerializationUser the parser supports additional RDF serialiazations not officially supported by Soprano.

virtual QStringList Soprano::Parser::supportedUserSerializations

(

)

const [virtual]

A parser can support additional RDF serializations that are not defined in Soprano::RdfSerialization. In that case supportedSerializations() has to include Soprano::SerializationUser.

The default implementation returns an empty list.

Returns:

A list of supported user RDF serializations.

bool Soprano::Parser::supportsSerialization	(	RdfSerialization	s,
		const QString &	userSerialization = QString()
	)			const

Check if a plugin supports a specific serialization.

Parameters:

	s	The requested serialization.
	userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the requested serialization. It allows the extension of the Soprano Parser interface with new RDF serializations that are not officially supported by Soprano.

Returns:

true if the parser is able to parse RDF data encoded in serialization s, false otherwise.

virtual StatementIterator Soprano::Parser::parseFile	(	const QString &	filename,
		const QUrl &	baseUri,
		RdfSerialization	serialization,
		const QString &	userSerialization = QString()
	)			const [virtual]

Parse an RDF model which has been serialized in a file, using the supplied baseURI to resolve any relative URI references.

The default implementation simply calls parseStream() on an opened QFile instance.

Parameters:

	filename	The name (path) of the file to parse
	baseUri	The base URI to be used for relative references.
	serialization	The serialization used in the file.
	userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Parser interface with new RDF serializations that are not officially supported by Soprano.

Returns:

An iterator that iterates over the result statements.

virtual StatementIterator Soprano::Parser::parseString	(	const QString &	data,
		const QUrl &	baseUri,
		RdfSerialization	serialization,
		const QString &	userSerialization = QString()
	)			const [virtual]

Parse an RDF model which has been serialized into a string, using the supplied baseURI to resolve any relative URI references.

The default implementation simply calls parseStream().

Parameters:

	data	The serialized RDF string.
	baseUri	The base URI to be used for relative references.
	serialization	The serialization used for the string data.
	userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Parser interface with new RDF serializations that are not officially supported by Soprano.

Returns:

An iterator that iterates over the result statements.

virtual StatementIterator Soprano::Parser::parseStream	(	QTextStream &	stream,
		const QUrl &	baseUri,
		RdfSerialization	serialization,
		const QString &	userSerialization = QString()
	)			const [pure virtual]

Read a serialized RDF model from a test stream, using the supplied baseURI to resolve any relative URI references.

Parameters:

	stream	The text stream to read the serialized RDF data from.
	baseUri	The base URI to be used for relative references.
	serialization	The serialization used for the string data from the stream.
	userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Parser interface with new RDF serializations that are not officially supported by Soprano.

Returns:

An iterator that iterates over the result statements.

---

The documentation for this class was generated from the following file:

• /builddir/build/BUILD/soprano-2.3.1/soprano/parser.h