Soprano  2.9.3
Public Member Functions | Protected Member Functions | List of all members
Soprano::Serializer Class Referenceabstract

Soprano::Serializer defines the interface for a Soprano RDF serializer plugin. More...

#include <Soprano/Serializer>

+ Inheritance diagram for Soprano::Serializer:

Public Member Functions

virtual ~Serializer ()
 
virtual RdfSerializations supportedSerializations () const =0
 
virtual QStringList supportedUserSerializations () const
 
bool supportsSerialization (RdfSerialization s, const QString &userSerialization=QString()) const
 
virtual bool serialize (StatementIterator it, QTextStream &stream, RdfSerialization serialization, const QString &userSerialization=QString()) const =0
 
void addPrefix (const QString &qname, const QUrl &uri) const
 
void clearPrefixes () const
 
QHash< QString, QUrlprefixes () const
 
- Public Member Functions inherited from Soprano::Plugin
virtual ~Plugin ()
 
QString pluginName () const
 
virtual bool isAvailable () const
 
- Public Member Functions inherited from Soprano::Error::ErrorCache
virtual ~ErrorCache ()
 
virtual Error lastError () const
 

Protected Member Functions

 Serializer (const QString &name)
 
- Protected Member Functions inherited from Soprano::Plugin
 Plugin (const QString &name)
 
- Protected Member Functions inherited from Soprano::Error::ErrorCache
 ErrorCache ()
 
void clearError () const
 
void setError (const Error &) const
 
void setError (const QString &errorMessage, int code=ErrorUnknown) const
 

Detailed Description

Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.

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

Usage

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

Then serializing RDF data is done in a single method call which writes the serialized data to a QTextStream:

QTextStream stream( stdout );
See Also
Writing Soprano Plugins
Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org

Definition at line 68 of file serializer.h.

Constructor & Destructor Documentation

virtual Soprano::Serializer::~Serializer ( )
virtual
Soprano::Serializer::Serializer ( const QString name)
protected

Member Function Documentation

virtual RdfSerializations Soprano::Serializer::supportedSerializations ( ) const
pure virtual

The serialiazation types supported by this serializer.

Returns
A combination of Soprano::RdfSerialization types. If the list contains Soprano::SerializationUser the serializer supports additional RDF serialiazations not officially supported by Soprano.
virtual QStringList Soprano::Serializer::supportedUserSerializations ( ) const
virtual

A serializer 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::Serializer::supportsSerialization ( RdfSerialization  s,
const QString userSerialization = QString() 
) const

Check if a plugin supports a specific serialization.

Parameters
sThe requested serialization.
userSerializationIf serialization is set to Soprano::SerializationUser this parameter specifies the requested serialization. It allows the extension of the Soprano Serializer interface with new RDF serializations that are not officially supported by Soprano.
Returns
true if the serializer is able to parse RDF data encoded in serialization s, false otherwise.
virtual bool Soprano::Serializer::serialize ( StatementIterator  it,
QTextStream stream,
RdfSerialization  serialization,
const QString userSerialization = QString() 
) const
pure virtual

Serialize a list of statements.

Parameters
itAn iterator containing the statements to be serialized.
streamThe stream the serialized data should be written to.
serializationThe encoding to be used.
userSerializationIf serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Serializer interface with new RDF serializations that are not officially supported by Soprano.
Returns
true if the serialization was successful, false otherwise.
void Soprano::Serializer::addPrefix ( const QString qname,
const QUrl uri 
) const

Add a prefix to be used by the serializer.

Be aware that serializer instances are reused. Thus, it is highly recommended to clear prefixes after using the Serializer. A future version of Soprano will have a revised Serializer API which handles this issue more effective.

Method is const for historical reasons.

Since
2.3
void Soprano::Serializer::clearPrefixes ( ) const

Clear all prefixes set via addPrefix.

Method is const for historical reasons.

Since
2.3
QHash<QString, QUrl> Soprano::Serializer::prefixes ( ) const

Retrieve all prefixes set via addPrefix.

Returns
a QHash containing of the prefixe qnames and their URIs.
Since
2.3

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