<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Soprano: Soprano::Serializer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <script type="text/javascript"> function hasClass(ele,cls) { return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)')); } function addClass(ele,cls) { if (!this.hasClass(ele,cls)) ele.className += " "+cls; } function removeClass(ele,cls) { if (hasClass(ele,cls)) { var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)'); ele.className=ele.className.replace(reg,' '); } } function toggleVisibility(linkObj) { var base = linkObj.getAttribute('id'); var summary = document.getElementById(base + '-summary'); var content = document.getElementById(base + '-content'); var trigger = document.getElementById(base + '-trigger'); if ( hasClass(linkObj,'closed') ) { summary.style.display = 'none'; content.style.display = 'block'; trigger.src = 'open.png'; removeClass(linkObj,'closed'); addClass(linkObj,'opened'); } else if ( hasClass(linkObj,'opened') ) { summary.style.display = 'block'; content.style.display = 'none'; trigger.src = 'closed.png'; removeClass(linkObj,'opened'); addClass(linkObj,'closed'); } return false; } </script> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"> <ul> <li><a class="el" href="namespaceSoprano.html">Soprano</a> </li> <li><a class="el" href="classSoprano_1_1Serializer.html">Soprano::Serializer</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <h1>Soprano::Serializer Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Soprano::Serializer" --><!-- doxytag: inherits="Soprano::Plugin,Soprano::Error::ErrorCache" --> <p><a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Soprano::Serializer</a> defines the interface for a <a class="el" href="namespaceSoprano.html">Soprano</a> RDF serializer plugin. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="serializer_8h_source.html">Soprano/Serializer</a>></code></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for Soprano::Serializer:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"><img src="classSoprano_1_1Serializer__inherit__graph.png" border="0" usemap="#Soprano_1_1Serializer_inherit__map" alt="Inheritance graph"/></div> <map name="Soprano_1_1Serializer_inherit__map" id="Soprano_1_1Serializer_inherit__map"> <area shape="rect" id="node2" href="classSoprano_1_1Plugin.html" title="Base class for all plugins in Soprano." alt="" coords="5,5,120,35"/><area shape="rect" id="node4" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="144,5,323,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classSoprano_1_1Serializer-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a9c5cb088325f38c04f0a737b998dbe5a">~Serializer</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual RdfSerializations </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a5ea7567881e17b08522d339fde11433f">supportedSerializations</a> () const =0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a91d04f7180bc78c0ff8c956707691e98">supportedUserSerializations</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#ae5cc61e9804e4c5c71fd54115b5371c5">supportsSerialization</a> (<a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">RdfSerialization</a> s, const <a class="elRef" href="qstring.html">QString</a> &userSerialization=<a class="elRef" href="qstring.html">QString</a>()) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a572f4a2a3433d53a94d854b5408588ad">serialize</a> (<a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> it, <a class="elRef" href="qtextstream.html">QTextStream</a> &stream, <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">RdfSerialization</a> serialization, const <a class="elRef" href="qstring.html">QString</a> &userSerialization=<a class="elRef" href="qstring.html">QString</a>()) const =0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a2f499548d34a3e780f952099e1344351">addPrefix</a> (const <a class="elRef" href="qstring.html">QString</a> &qname, const <a class="elRef" href="qurl.html">QUrl</a> &uri) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a6037028289edaac184298692891f3838">clearPrefixes</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qhash.html">QHash</a>< <a class="elRef" href="qstring.html">QString</a>, <a class="elRef" href="qurl.html">QUrl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#a087c22db1ec37ba8718a501a54bcbff1">prefixes</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Serializer.html#acd5420498df3cd83daca862e13712597">Serializer</a> (const <a class="elRef" href="qstring.html">QString</a> &name)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Soprano::Serializer</a> defines the interface for a <a class="el" href="namespaceSoprano.html">Soprano</a> RDF serializer plugin. </p> <p>Each serializer plugin may support multiple RDF serializations (<a class="el" href="classSoprano_1_1Serializer.html#a5ea7567881e17b08522d339fde11433f">supportedSerializations()</a>).</p> <h2><a class="anchor" id="Usage"></a> Usage</h2> <p>Using a <a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Serializer</a> is straightforward. One starts by getting a plugin that supports the requested RDF data serialization:</p> <div class="fragment"><pre class="fragment"> <a class="code" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Soprano::Serializer</a>* s = <a class="code" href="classSoprano_1_1PluginManager.html#a922c00336d39542a289e9b82a39e25b2">Soprano::PluginManager::instance</a>()->discoverSerializerForSerialization( <a class="code" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0a1e1568be674d28e0e0712e8a36dca70f">Soprano::SerializationRdfXml</a> ); </pre></div><p>Then serializing RDF data is done in a single method call which writes the serialized data to a <a class="elRef" href="qtextstream.html">QTextStream</a>:</p> <div class="fragment"><pre class="fragment"> <a class="codeRef" href="qtextstream.html">QTextStream</a> stream( stdout ); s-><a class="code" href="classSoprano_1_1Serializer.html#a572f4a2a3433d53a94d854b5408588ad">serialize</a>( model-><a class="code" href="classSoprano_1_1Model.html#a7f50dc6483e0bed7830877182c7906ac">listStatements</a>(), stream, Soprano::SerializationRdfXml ); </pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="soprano_writing_plugins.html">Writing Soprano Plugins</a></dd></dl> <dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>> </dd></dl> <p>Definition at line <a class="el" href="serializer_8h_source.html#l00068">68</a> of file <a class="el" href="serializer_8h_source.html">serializer.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a9c5cb088325f38c04f0a737b998dbe5a"></a><!-- doxytag: member="Soprano::Serializer::~Serializer" ref="a9c5cb088325f38c04f0a737b998dbe5a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Soprano::Serializer::~Serializer </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="acd5420498df3cd83daca862e13712597"></a><!-- doxytag: member="Soprano::Serializer::Serializer" ref="acd5420498df3cd83daca862e13712597" args="(const QString &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Soprano::Serializer::Serializer </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5ea7567881e17b08522d339fde11433f"></a><!-- doxytag: member="Soprano::Serializer::supportedSerializations" ref="a5ea7567881e17b08522d339fde11433f" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual RdfSerializations Soprano::Serializer::supportedSerializations </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The serialiazation types supported by this serializer. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A combination of <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">Soprano::RdfSerialization</a> types. If the list contains <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0a45b9210a9b125009dfee9ac20af126d3">Soprano::SerializationUser</a> the serializer supports additional RDF serialiazations not officially supported by Soprano. </dd></dl> </div> </div> <a class="anchor" id="a91d04f7180bc78c0ff8c956707691e98"></a><!-- doxytag: member="Soprano::Serializer::supportedUserSerializations" ref="a91d04f7180bc78c0ff8c956707691e98" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="elRef" href="qstringlist.html">QStringList</a> Soprano::Serializer::supportedUserSerializations </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A serializer can support additional RDF serializations that are not defined in <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">Soprano::RdfSerialization</a>. In that case <a class="el" href="classSoprano_1_1Serializer.html#a5ea7567881e17b08522d339fde11433f">supportedSerializations()</a> has to include <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0a45b9210a9b125009dfee9ac20af126d3">Soprano::SerializationUser</a>.</p> <p>The default implementation returns an empty list.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>A list of supported user RDF serializations. </dd></dl> </div> </div> <a class="anchor" id="ae5cc61e9804e4c5c71fd54115b5371c5"></a><!-- doxytag: member="Soprano::Serializer::supportsSerialization" ref="ae5cc61e9804e4c5c71fd54115b5371c5" args="(RdfSerialization s, const QString &userSerialization=QString()) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Soprano::Serializer::supportsSerialization </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">RdfSerialization</a> </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"> <em>userSerialization</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Check if a plugin supports a specific serialization.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>The requested serialization. </td></tr> <tr><td valign="top"></td><td valign="top"><em>userSerialization</em> </td><td>If serialization is set to <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0a45b9210a9b125009dfee9ac20af126d3">Soprano::SerializationUser</a> this parameter specifies the requested serialization. It allows the extension of the Soprano <a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Serializer</a> interface with new RDF serializations that are not officially supported by Soprano.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the serializer is able to parse RDF data encoded in serialization s, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="a572f4a2a3433d53a94d854b5408588ad"></a><!-- doxytag: member="Soprano::Serializer::serialize" ref="a572f4a2a3433d53a94d854b5408588ad" args="(StatementIterator it, QTextStream &stream, RdfSerialization serialization, const QString &userSerialization=QString()) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Soprano::Serializer::serialize </td> <td>(</td> <td class="paramtype"><a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> </td> <td class="paramname"> <em>it</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="elRef" href="qtextstream.html">QTextStream</a> & </td> <td class="paramname"> <em>stream</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0">RdfSerialization</a> </td> <td class="paramname"> <em>serialization</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"> <em>userSerialization</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Serialize a list of statements.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>it</em> </td><td>An iterator containing the statements to be serialized. </td></tr> <tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>The stream the serialized data should be written to. </td></tr> <tr><td valign="top"></td><td valign="top"><em>serialization</em> </td><td>The encoding to be used. </td></tr> <tr><td valign="top"></td><td valign="top"><em>userSerialization</em> </td><td>If serialization is set to <a class="el" href="namespaceSoprano.html#a870b14710c2cc2b825b4b287f01a35e0a45b9210a9b125009dfee9ac20af126d3">Soprano::SerializationUser</a> this parameter specifies the serialization to use. It allows the extension of the Soprano <a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Serializer</a> interface with new RDF serializations that are not officially supported by Soprano.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the serialization was successful, false otherwise. </dd></dl> </div> </div> <a class="anchor" id="a2f499548d34a3e780f952099e1344351"></a><!-- doxytag: member="Soprano::Serializer::addPrefix" ref="a2f499548d34a3e780f952099e1344351" args="(const QString &qname, const QUrl &uri) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Soprano::Serializer::addPrefix </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"> <em>qname</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" href="qurl.html">QUrl</a> & </td> <td class="paramname"> <em>uri</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Add a prefix to be used by the serializer.</p> <p>Be aware that serializer instances are reused. Thus, it is highly recommended to clear prefixes after using the <a class="el" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin.">Serializer</a>. A future version of Soprano will have a revised Serializer API which handles this issue more effective.</p> <p>Method is const for historical reasons.</p> <dl class="since"><dt><b>Since:</b></dt><dd>2.3 </dd></dl> </div> </div> <a class="anchor" id="a6037028289edaac184298692891f3838"></a><!-- doxytag: member="Soprano::Serializer::clearPrefixes" ref="a6037028289edaac184298692891f3838" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Soprano::Serializer::clearPrefixes </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Clear all prefixes set via addPrefix.</p> <p>Method is const for historical reasons.</p> <dl class="since"><dt><b>Since:</b></dt><dd>2.3 </dd></dl> </div> </div> <a class="anchor" id="a087c22db1ec37ba8718a501a54bcbff1"></a><!-- doxytag: member="Soprano::Serializer::prefixes" ref="a087c22db1ec37ba8718a501a54bcbff1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="qhash.html">QHash</a><<a class="elRef" href="qstring.html">QString</a>, <a class="elRef" href="qurl.html">QUrl</a>> Soprano::Serializer::prefixes </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Retrieve all prefixes set via addPrefix.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="elRef" href="qhash.html">QHash</a> containing of the prefixe qnames and their URIs.</dd></dl> <dl class="since"><dt><b>Since:</b></dt><dd>2.3 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>/builddir/build/BUILD/soprano-2.5.2/soprano/<a class="el" href="serializer_8h_source.html">serializer.h</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Thu Oct 21 2010 for Soprano by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>