KDE 4.2 API Reference soprano
Soprano::Serializer Class Reference
#include <Soprano/Serializer>
Inheritance diagram for Soprano::Serializer:
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:
Soprano::Serializer* s = Soprano::PluginManager::instance()->discoverSerializerForSerialization( Soprano::SerializationRdfXml );
Then serializing RDF data is done in a single method call which writes the serialized data to a QTextStream:
QTextStream stream( stdout ); s->serialize( model->listStatements(), stream, Soprano::SerializationRdfXml );
- See also:
- Writing Soprano Plugins
Definition at line 65 of file serializer.h.
Public Member Functions | |
| virtual bool | serialize (StatementIterator it, QTextStream &stream, RdfSerialization serialization, const QString &userSerialization=QString()) const =0 |
| virtual RdfSerializations | supportedSerializations () const =0 |
| virtual QStringList | supportedUserSerializations () const |
| bool | supportsSerialization (RdfSerialization s, const QString &userSerialization=QString()) const |
| virtual | ~Serializer () |
Protected Member Functions | |
| Serializer (const QString &name) | |
Constructor & Destructor Documentation
| virtual Soprano::Serializer::~Serializer | ( | ) | [virtual] |
| Soprano::Serializer::Serializer | ( | const QString & | name | ) | [protected] |
Member Function Documentation
| virtual bool Soprano::Serializer::serialize | ( | StatementIterator | it, | |
| QTextStream & | stream, | |||
| RdfSerialization | serialization, | |||
| const QString & | userSerialization = QString() | |||
| ) | const [pure virtual] |
Serialize a list of statements.
- Parameters:
-
it An iterator containing the statements to be serialized. stream The stream the serialized data should be written to. serialization The encoding to be used. userSerialization If 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:
trueif the serialization was successful, false otherwise.
| 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:
-
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 Serializer interface with new RDF serializations that are not officially supported by Soprano.
- Returns:
trueif the serializer is able to parse RDF data encoded in serialization s,falseotherwise.
The documentation for this class was generated from the following file:
