File: flickcurl-section-serializer.html

package info (click to toggle)
flickcurl 1.26-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,784 kB
  • sloc: ansic: 26,045; sh: 11,915; xml: 1,025; makefile: 343
file content (230 lines) | stat: -rw-r--r-- 11,940 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Serializer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="up" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="prev" href="flickcurl-section-reflection.html" title="Reflection">
<link rel="next" href="flickcurl-section-stats.html" title="Statistics.">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="flickcurl-section-reflection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Flickcurl Flickr API Manual</th>
<td><a accesskey="n" href="flickcurl-section-stats.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#flickcurl-section-serializer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#flickcurl-section-serializer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="flickcurl-section-serializer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="flickcurl-section-serializer.top_of_page"></a>Serializer</span></h2>
<p>Serializer — Serialize a photo to RDF Triples.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="flickcurl-section-serializer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef             <a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer">flickcurl_serializer</a>;
                    <a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer-factory" title="flickcurl_serializer_factory">flickcurl_serializer_factory</a>;
<a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="returnvalue">flickcurl_serializer</span></a> * <a class="link" href="flickcurl-section-serializer.html#flickcurl-new-serializer" title="flickcurl_new_serializer ()">flickcurl_new_serializer</a>         (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer-factory" title="flickcurl_serializer_factory"><span class="type">flickcurl_serializer_factory</span></a> *factory</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="flickcurl-section-serializer.html#flickcurl-free-serializer" title="flickcurl_free_serializer ()">flickcurl_free_serializer</a>           (<em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="type">flickcurl_serializer</span></a> *serializer</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="flickcurl-section-serializer.html#flickcurl-serialize-photo" title="flickcurl_serialize_photo ()">flickcurl_serialize_photo</a>           (<em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="type">flickcurl_serializer</span></a> *fcs</code></em>,
                                                         <em class="parameter"><code><a class="link" href="flickcurl-section-photo.html#flickcurl-photo" title="flickcurl_photo"><span class="type">flickcurl_photo</span></a> *photo</code></em>);
enum                <a class="link" href="flickcurl-section-serializer.html#flickcurl-term-type" title="enum flickcurl_term_type">flickcurl_term_type</a>;
</pre>
</div>
<div class="refsect1">
<a name="flickcurl-section-serializer.description"></a><h2>Description</h2>
<p>
Serialize a photo to RDF Triples.
</p>
</div>
<div class="refsect1">
<a name="flickcurl-section-serializer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="flickcurl-serializer"></a><h3>flickcurl_serializer</h3>
<pre class="programlisting">typedef struct flickcurl_serializer_s flickcurl_serializer;
</pre>
<p>
Serializer from Photo and metadata to RDF triples
</p>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-serializer-factory"></a><h3>flickcurl_serializer_factory</h3>
<pre class="programlisting">typedef struct {
  int version;
  void (*emit_namespace)(void* user_data, const char* prefix, size_t prefix_len, const char* uri, size_t uri_len);
  void (*emit_triple)(void* user_data,
                      const char* subject, int subject_type,
                      const char* predicate_nspace, const char* predicate_name,
                      const char *object, int object_type,
                      const char *datatype_uri);
  void (*emit_finish)(void* user_data);
} flickcurl_serializer_factory;
</pre>
<p>
Triples serializer factory
</p>
<p>
API version 1 is all that is supported.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-serializer-factory.version"></a>version</code></em>;</span></p></td>
<td>API version</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="flickcurl-serializer-factory.emit-namespace"></a>emit_namespace</code></em> ()</span></p></td>
<td>(V1) emit namespace callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="flickcurl-serializer-factory.emit-triple"></a>emit_triple</code></em> ()</span></p></td>
<td>(V1) emit a triple</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="flickcurl-serializer-factory.emit-finish"></a>emit_finish</code></em> ()</span></p></td>
<td>(V1) finish emitting</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-new-serializer"></a><h3>flickcurl_new_serializer ()</h3>
<pre class="programlisting"><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="returnvalue">flickcurl_serializer</span></a> * flickcurl_new_serializer         (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer-factory" title="flickcurl_serializer_factory"><span class="type">flickcurl_serializer_factory</span></a> *factory</code></em>);</pre>
<p>
Create a new triples serializer for generating a RDF triples
representation of a Flickr photo.
</p>
<p>
The factory must contain the methods and the correct factory API
version as described in <a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer-factory" title="flickcurl_serializer_factory"><span class="type">flickcurl_serializer_factory</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
<td>flickcurl object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data for factory methods</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>triples serializer factory</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new serializer object or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-free-serializer"></a><h3>flickcurl_free_serializer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                flickcurl_free_serializer           (<em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="type">flickcurl_serializer</span></a> *serializer</code></em>);</pre>
<p>
Destructor for triples serializer object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>serializer</code></em> :</span></p></td>
<td>serializer object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-serialize-photo"></a><h3>flickcurl_serialize_photo ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 flickcurl_serialize_photo           (<em class="parameter"><code><a class="link" href="flickcurl-section-serializer.html#flickcurl-serializer" title="flickcurl_serializer"><span class="type">flickcurl_serializer</span></a> *fcs</code></em>,
                                                         <em class="parameter"><code><a class="link" href="flickcurl-section-photo.html#flickcurl-photo" title="flickcurl_photo"><span class="type">flickcurl_photo</span></a> *photo</code></em>);</pre>
<p>
Serialize photo description to RDF triples
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fcs</code></em> :</span></p></td>
<td>flickcurl serializer object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo</code></em> :</span></p></td>
<td>photo object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-0 on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-term-type"></a><h3>enum flickcurl_term_type</h3>
<pre class="programlisting">typedef enum {
  FLICKCURL_TERM_TYPE_RESOURCE = 1,
  FLICKCURL_TERM_TYPE_BLANK    = 2,
  FLICKCURL_TERM_TYPE_LITERAL  = 5
} flickcurl_term_type;
</pre>
<p>
Triple part types
</p>
<p>
These are the same enumeration values as used by Raptor V2
raptor_term_type enumeration and Raptor V1 raptor_identifier_type
enumeration.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="FLICKCURL-TERM-TYPE-RESOURCE:CAPS"></a><span class="term"><code class="literal">FLICKCURL_TERM_TYPE_RESOURCE</code></span></p></td>
<td>resource/URI term
</td>
</tr>
<tr>
<td><p><a name="FLICKCURL-TERM-TYPE-BLANK:CAPS"></a><span class="term"><code class="literal">FLICKCURL_TERM_TYPE_BLANK</code></span></p></td>
<td>blank node/anonymous term
</td>
</tr>
<tr>
<td><p><a name="FLICKCURL-TERM-TYPE-LITERAL:CAPS"></a><span class="term"><code class="literal">FLICKCURL_TERM_TYPE_LITERAL</code></span></p></td>
<td>literal term
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>