| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>Query Results Formatter</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| 7 |
<link rel="home" href="index.html" title="Rasqal RDF Query Library Manual"> |
| 8 |
<link rel="up" href="reference-manual.html" title="Part I. Reference Manual"> |
| 9 |
<link rel="prev" href="rasqal-section-query-results.html" title="Query Results"> |
| 10 |
<link rel="next" href="rasqal-section-row.html" title="Query Result Row"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| 16 |
<tr valign="middle"> |
| 17 |
<td><a accesskey="p" href="rasqal-section-query-results.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| 18 |
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| 20 |
<th width="100%" align="center">Rasqal RDF Query Library Manual</th> |
| 21 |
<td><a accesskey="n" href="rasqal-section-row.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| 22 |
</tr> |
| 23 |
<tr><td colspan="5" class="shortcuts"> |
| 24 |
<a href="#rasqal-section-query-results-formatter.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#rasqal-section-query-results-formatter.description" class="shortcut">Description</a> |
| 27 |
</td></tr> |
| 28 |
</table> |
| 29 |
<div class="refentry"> |
| 30 |
<a name="rasqal-section-query-results-formatter"></a><div class="titlepage"></div> |
| 31 |
<div class="refnamediv"><table width="100%"><tr> |
| 32 |
<td valign="top"> |
| 33 |
<h2><span class="refentrytitle"><a name="rasqal-section-query-results-formatter.top_of_page"></a>Query Results Formatter</span></h2> |
| 34 |
<p>Query Results Formatter — Query results formatted into a syntax.</p> |
| 35 |
</td> |
| 36 |
<td valign="top" align="right"></td> |
| 37 |
</tr></table></div> |
| 38 |
<div class="refsynopsisdiv"> |
| 39 |
<a name="rasqal-section-query-results-formatter.synopsis"></a><h2>Synopsis</h2> |
| 40 |
<pre class="synopsis">typedef <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter">rasqal_query_results_formatter</a>; |
| 41 |
enum <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-format-flags" title="enum rasqal_query_results_format_flags">rasqal_query_results_format_flags</a>; |
| 42 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-check" title="rasqal_query_results_formats_check ()">rasqal_query_results_formats_check</a> (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 43 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 44 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 45 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 46 |
<em class="parameter"><code><span class="type">int</span> flags</code></em>); |
| 47 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-check2" title="rasqal_query_results_formats_check2 ()">rasqal_query_results_formats_check2</a> (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 48 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 49 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 50 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 51 |
<em class="parameter"><code><span class="type">int</span> flags</code></em>); |
| 52 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="returnvalue">rasqal_query_results_formatter</span></a> * <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-new-query-results-formatter" title="rasqal_new_query_results_formatter ()">rasqal_new_query_results_formatter</a> |
| 53 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 54 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 55 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 56 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>); |
| 57 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="returnvalue">rasqal_query_results_formatter</span></a> * <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-new-query-results-formatter-for-content" title="rasqal_new_query_results_formatter_for_content ()">rasqal_new_query_results_formatter_for_content</a> |
| 58 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 59 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 60 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 61 |
<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>, |
| 62 |
<em class="parameter"><code><span class="type">size_t</span> len</code></em>, |
| 63 |
<em class="parameter"><code>const unsigned <span class="type">char</span> *identifier</code></em>); |
| 64 |
<span class="returnvalue">void</span> <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-free-query-results-formatter" title="rasqal_free_query_results_formatter ()">rasqal_free_query_results_formatter</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>); |
| 65 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter-read" title="rasqal_query_results_formatter_read ()">rasqal_query_results_formatter_read</a> (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 66 |
<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 67 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>, |
| 68 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 69 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>); |
| 70 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter-write" title="rasqal_query_results_formatter_write ()">rasqal_query_results_formatter_write</a> |
| 71 |
(<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 72 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>, |
| 73 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 74 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>); |
| 75 |
</pre> |
| 76 |
</div> |
| 77 |
<div class="refsect1"> |
| 78 |
<a name="rasqal-section-query-results-formatter.description"></a><h2>Description</h2> |
| 79 |
<p> |
| 80 |
Variable bindings and boolean query results can be formatted into |
| 81 |
different syntaxes such as SPARQL Query Results Format or JSON. |
| 82 |
The rasqal_query_results_formatter class allows choosing a formatter |
| 83 |
for a particular syntax and writing the syntax to a raptor_iostream |
| 84 |
which allows turning the syntax into a string, writing to a file |
| 85 |
handle or other custom destination. |
| 86 |
</p> |
| 87 |
</div> |
| 88 |
<div class="refsect1"> |
| 89 |
<a name="rasqal-section-query-results-formatter.details"></a><h2>Details</h2> |
| 90 |
<div class="refsect2"> |
| 91 |
<a name="rasqal-query-results-formatter"></a><h3>rasqal_query_results_formatter</h3> |
| 92 |
<pre class="programlisting">rasqal_graph_query_results_formatter* query_results_formatter; |
| 93 |
</pre> |
| 94 |
<p> |
| 95 |
Rasqal query results formatter class. |
| 96 |
</p> |
| 97 |
</div> |
| 98 |
<hr> |
| 99 |
<div class="refsect2"> |
| 100 |
<a name="rasqal-query-results-format-flags"></a><h3>enum rasqal_query_results_format_flags</h3> |
| 101 |
<pre class="programlisting">typedef enum { |
| 102 |
RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER = 1, |
| 103 |
RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER = 2 |
| 104 |
} rasqal_query_results_format_flags; |
| 105 |
</pre> |
| 106 |
<p> |
| 107 |
Bitflags for <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-check" title="rasqal_query_results_formats_check ()"><code class="function">rasqal_query_results_formats_check()</code></a> to find formats with features. |
| 108 |
</p> |
| 109 |
<div class="variablelist"><table border="0"> |
| 110 |
<col align="left" valign="top"> |
| 111 |
<tbody> |
| 112 |
<tr> |
| 113 |
<td><p><a name="RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</code></span></p></td> |
| 114 |
<td>format can be read. |
| 115 |
</td> |
| 116 |
</tr> |
| 117 |
<tr> |
| 118 |
<td><p><a name="RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</code></span></p></td> |
| 119 |
<td>format can be written. |
| 120 |
</td> |
| 121 |
</tr> |
| 122 |
</tbody> |
| 123 |
</table></div> |
| 124 |
</div> |
| 125 |
<hr> |
| 126 |
<div class="refsect2"> |
| 127 |
<a name="rasqal-query-results-formats-check"></a><h3>rasqal_query_results_formats_check ()</h3> |
| 128 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_formats_check (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 129 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 130 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 131 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 132 |
<em class="parameter"><code><span class="type">int</span> flags</code></em>);</pre> |
| 133 |
<p> |
| 134 |
Check if a query results formatter exists for the requested format. |
| 135 |
</p> |
| 136 |
<p> |
| 137 |
<em class="parameter"><code>Deprecated</code></em>: use <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-check2" title="rasqal_query_results_formats_check2 ()"><code class="function">rasqal_query_results_formats_check2()</code></a> since the |
| 138 |
implementation of this function returned an inverted boolean result. |
| 139 |
</p> |
| 140 |
<div class="variablelist"><table border="0"> |
| 141 |
<col align="left" valign="top"> |
| 142 |
<tbody> |
| 143 |
<tr> |
| 144 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 145 |
<td>rasqal_world object</td> |
| 146 |
</tr> |
| 147 |
<tr> |
| 148 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 149 |
<td>the query results format name (or NULL)</td> |
| 150 |
</tr> |
| 151 |
<tr> |
| 152 |
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> |
| 153 |
<td> |
| 154 |
<span class="type">raptor_uri</span> query results format uri (or NULL)</td> |
| 155 |
</tr> |
| 156 |
<tr> |
| 157 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 158 |
<td>mime type name</td> |
| 159 |
</tr> |
| 160 |
<tr> |
| 161 |
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> |
| 162 |
<td>bitmask of flags to signify that format is needed for reading (<a class="link" href="rasqal-section-query-results-formatter.html#RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS"><span class="type">RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</span></a> ) or writing ( <a class="link" href="rasqal-section-query-results-formatter.html#RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS"><span class="type">RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</span></a> )</td> |
| 163 |
</tr> |
| 164 |
<tr> |
| 165 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 166 |
<td>0 if a formatter exists.</td> |
| 167 |
</tr> |
| 168 |
</tbody> |
| 169 |
</table></div> |
| 170 |
</div> |
| 171 |
<hr> |
| 172 |
<div class="refsect2"> |
| 173 |
<a name="rasqal-query-results-formats-check2"></a><h3>rasqal_query_results_formats_check2 ()</h3> |
| 174 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_formats_check2 (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 175 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 176 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 177 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 178 |
<em class="parameter"><code><span class="type">int</span> flags</code></em>);</pre> |
| 179 |
<p> |
| 180 |
Check if a query results formatter exists for the requested format. |
| 181 |
</p> |
| 182 |
<div class="variablelist"><table border="0"> |
| 183 |
<col align="left" valign="top"> |
| 184 |
<tbody> |
| 185 |
<tr> |
| 186 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 187 |
<td>rasqal_world object</td> |
| 188 |
</tr> |
| 189 |
<tr> |
| 190 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 191 |
<td>the query results format name (or NULL)</td> |
| 192 |
</tr> |
| 193 |
<tr> |
| 194 |
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> |
| 195 |
<td> |
| 196 |
<span class="type">raptor_uri</span> query results format uri (or NULL)</td> |
| 197 |
</tr> |
| 198 |
<tr> |
| 199 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 200 |
<td>mime type name</td> |
| 201 |
</tr> |
| 202 |
<tr> |
| 203 |
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> |
| 204 |
<td>bitmask of flags to signify that format is needed for reading (<a class="link" href="rasqal-section-query-results-formatter.html#RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS"><span class="type">RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</span></a> ) or writing ( <a class="link" href="rasqal-section-query-results-formatter.html#RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS"><span class="type">RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</span></a> )</td> |
| 205 |
</tr> |
| 206 |
<tr> |
| 207 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 208 |
<td>non-0 if a formatter exists.</td> |
| 209 |
</tr> |
| 210 |
</tbody> |
| 211 |
</table></div> |
| 212 |
</div> |
| 213 |
<hr> |
| 214 |
<div class="refsect2"> |
| 215 |
<a name="rasqal-new-query-results-formatter"></a><h3>rasqal_new_query_results_formatter ()</h3> |
| 216 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="returnvalue">rasqal_query_results_formatter</span></a> * rasqal_new_query_results_formatter |
| 217 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 218 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 219 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 220 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>);</pre> |
| 221 |
<p> |
| 222 |
Constructor - create a new rasqal_query_results_formatter for an identified format. |
| 223 |
</p> |
| 224 |
<p> |
| 225 |
A query results format can be found by name, mime type or URI, all |
| 226 |
of which are optional. If multiple fields are given, the first |
| 227 |
match is given that matches the name, URI, mime_type in that |
| 228 |
order. The default query results format will be used if all are |
| 229 |
format identifying fields are NULL. |
| 230 |
</p> |
| 231 |
<p> |
| 232 |
See <a class="link" href="rasqal-section-general.html#rasqal-world-get-query-results-format-description" title="rasqal_world_get_query_results_format_description ()"><code class="function">rasqal_world_get_query_results_format_description()</code></a> for |
| 233 |
obtaining the supported format URIs at run time. |
| 234 |
</p> |
| 235 |
<div class="variablelist"><table border="0"> |
| 236 |
<col align="left" valign="top"> |
| 237 |
<tbody> |
| 238 |
<tr> |
| 239 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 240 |
<td>rasqal_world object</td> |
| 241 |
</tr> |
| 242 |
<tr> |
| 243 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 244 |
<td>the query results format name (or NULL)</td> |
| 245 |
</tr> |
| 246 |
<tr> |
| 247 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 248 |
<td>the query results format mime type (or NULL)</td> |
| 249 |
</tr> |
| 250 |
<tr> |
| 251 |
<td><p><span class="term"><em class="parameter"><code>format_uri</code></em> :</span></p></td> |
| 252 |
<td> |
| 253 |
<span class="type">raptor_uri</span> query results format uri (or NULL)</td> |
| 254 |
</tr> |
| 255 |
<tr> |
| 256 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 257 |
<td>a new <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object or NULL on failure</td> |
| 258 |
</tr> |
| 259 |
</tbody> |
| 260 |
</table></div> |
| 261 |
</div> |
| 262 |
<hr> |
| 263 |
<div class="refsect2"> |
| 264 |
<a name="rasqal-new-query-results-formatter-for-content"></a><h3>rasqal_new_query_results_formatter_for_content ()</h3> |
| 265 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="returnvalue">rasqal_query_results_formatter</span></a> * rasqal_new_query_results_formatter_for_content |
| 266 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 267 |
<em class="parameter"><code><span class="type">raptor_uri</span> *uri</code></em>, |
| 268 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 269 |
<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>, |
| 270 |
<em class="parameter"><code><span class="type">size_t</span> len</code></em>, |
| 271 |
<em class="parameter"><code>const unsigned <span class="type">char</span> *identifier</code></em>);</pre> |
| 272 |
<p> |
| 273 |
Constructor - create a new queryresults formatter for an identified format. |
| 274 |
</p> |
| 275 |
<p> |
| 276 |
Uses <a class="link" href="rasqal-section-general.html#rasqal-world-guess-query-results-format-name" title="rasqal_world_guess_query_results_format_name ()"><code class="function">rasqal_world_guess_query_results_format_name()</code></a> to find a |
| 277 |
query results formatter by scoring recognition of the syntax by a |
| 278 |
block of characters, the content identifier or a mime type. The |
| 279 |
content identifier is typically a filename or URI or some other |
| 280 |
identifier. |
| 281 |
</p> |
| 282 |
<div class="variablelist"><table border="0"> |
| 283 |
<col align="left" valign="top"> |
| 284 |
<tbody> |
| 285 |
<tr> |
| 286 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 287 |
<td>world object</td> |
| 288 |
</tr> |
| 289 |
<tr> |
| 290 |
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> |
| 291 |
<td>URI identifying the syntax (or NULL)</td> |
| 292 |
</tr> |
| 293 |
<tr> |
| 294 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 295 |
<td>mime type identifying the content (or NULL)</td> |
| 296 |
</tr> |
| 297 |
<tr> |
| 298 |
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> |
| 299 |
<td>buffer of content to guess (or NULL)</td> |
| 300 |
</tr> |
| 301 |
<tr> |
| 302 |
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> |
| 303 |
<td>length of buffer</td> |
| 304 |
</tr> |
| 305 |
<tr> |
| 306 |
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td> |
| 307 |
<td>identifier of content (or NULL)</td> |
| 308 |
</tr> |
| 309 |
<tr> |
| 310 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 311 |
<td>a new <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object or NULL on failure</td> |
| 312 |
</tr> |
| 313 |
</tbody> |
| 314 |
</table></div> |
| 315 |
</div> |
| 316 |
<hr> |
| 317 |
<div class="refsect2"> |
| 318 |
<a name="rasqal-free-query-results-formatter"></a><h3>rasqal_free_query_results_formatter ()</h3> |
| 319 |
<pre class="programlisting"><span class="returnvalue">void</span> rasqal_free_query_results_formatter (<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>);</pre> |
| 320 |
<p> |
| 321 |
Destructor - destroy a <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object. |
| 322 |
</p> |
| 323 |
<div class="variablelist"><table border="0"> |
| 324 |
<col align="left" valign="top"> |
| 325 |
<tbody><tr> |
| 326 |
<td><p><span class="term"><em class="parameter"><code>formatter</code></em> :</span></p></td> |
| 327 |
<td> |
| 328 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object</td> |
| 329 |
</tr></tbody> |
| 330 |
</table></div> |
| 331 |
</div> |
| 332 |
<hr> |
| 333 |
<div class="refsect2"> |
| 334 |
<a name="rasqal-query-results-formatter-read"></a><h3>rasqal_query_results_formatter_read ()</h3> |
| 335 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_formatter_read (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 336 |
<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 337 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>, |
| 338 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 339 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>);</pre> |
| 340 |
<p> |
| 341 |
Read the query results using the given formatter from an iostream |
| 342 |
</p> |
| 343 |
<p> |
| 344 |
See <a class="link" href="rasqal-section-general.html#rasqal-world-get-query-results-format-description" title="rasqal_world_get_query_results_format_description ()"><code class="function">rasqal_world_get_query_results_format_description()</code></a> for |
| 345 |
obtaining the supported format URIs at run time. |
| 346 |
</p> |
| 347 |
<div class="variablelist"><table border="0"> |
| 348 |
<col align="left" valign="top"> |
| 349 |
<tbody> |
| 350 |
<tr> |
| 351 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 352 |
<td>rasqal world object</td> |
| 353 |
</tr> |
| 354 |
<tr> |
| 355 |
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td> |
| 356 |
<td> |
| 357 |
<span class="type">raptor_iostream</span> to read the query from</td> |
| 358 |
</tr> |
| 359 |
<tr> |
| 360 |
<td><p><span class="term"><em class="parameter"><code>formatter</code></em> :</span></p></td> |
| 361 |
<td> |
| 362 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object</td> |
| 363 |
</tr> |
| 364 |
<tr> |
| 365 |
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td> |
| 366 |
<td> |
| 367 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query results format</td> |
| 368 |
</tr> |
| 369 |
<tr> |
| 370 |
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td> |
| 371 |
<td> |
| 372 |
<span class="type">raptor_uri</span> base URI of the input format</td> |
| 373 |
</tr> |
| 374 |
<tr> |
| 375 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 376 |
<td>non-0 on failure</td> |
| 377 |
</tr> |
| 378 |
</tbody> |
| 379 |
</table></div> |
| 380 |
</div> |
| 381 |
<hr> |
| 382 |
<div class="refsect2"> |
| 383 |
<a name="rasqal-query-results-formatter-write"></a><h3>rasqal_query_results_formatter_write ()</h3> |
| 384 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_formatter_write |
| 385 |
(<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 386 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> *formatter</code></em>, |
| 387 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 388 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>);</pre> |
| 389 |
<p> |
| 390 |
Write the query results using the given formatter to an iostream |
| 391 |
</p> |
| 392 |
<p> |
| 393 |
Note that after calling this method, the query results will be |
| 394 |
empty and <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-finished" title="rasqal_query_results_finished ()"><code class="function">rasqal_query_results_finished()</code></a> will return true (non-0) |
| 395 |
</p> |
| 396 |
<p> |
| 397 |
See <a class="link" href="rasqal-section-general.html#rasqal-world-get-query-results-format-description" title="rasqal_world_get_query_results_format_description ()"><code class="function">rasqal_world_get_query_results_format_description()</code></a> for |
| 398 |
obtaining the supported format URIs at run time. |
| 399 |
</p> |
| 400 |
<div class="variablelist"><table border="0"> |
| 401 |
<col align="left" valign="top"> |
| 402 |
<tbody> |
| 403 |
<tr> |
| 404 |
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td> |
| 405 |
<td> |
| 406 |
<span class="type">raptor_iostream</span> to write the query to</td> |
| 407 |
</tr> |
| 408 |
<tr> |
| 409 |
<td><p><span class="term"><em class="parameter"><code>formatter</code></em> :</span></p></td> |
| 410 |
<td> |
| 411 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> object</td> |
| 412 |
</tr> |
| 413 |
<tr> |
| 414 |
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td> |
| 415 |
<td> |
| 416 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query results format</td> |
| 417 |
</tr> |
| 418 |
<tr> |
| 419 |
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td> |
| 420 |
<td> |
| 421 |
<span class="type">raptor_uri</span> base URI of the output format (or NULL)</td> |
| 422 |
</tr> |
| 423 |
<tr> |
| 424 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 425 |
<td>non-0 on failure</td> |
| 426 |
</tr> |
| 427 |
</tbody> |
| 428 |
</table></div> |
| 429 |
</div> |
| 430 |
</div> |
| 431 |
</div> |
| 432 |
<div class="footer"> |
| 433 |
<hr> |
| 434 |
Generated by GTK-Doc V1.18</div> |
| 435 |
</body> |
| 436 |
</html> |