1
<?xml version="1.0" encoding="utf-8"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>Redland RDF Language Bindings - Ruby RDoc - Class: Redland::Serializer</title>
7
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
8
<script src="../js/jquery.js" type="text/javascript" charset="utf-8">
10
<script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8">
12
<script src="../js/quicksearch.js" type="text/javascript" charset="utf-8">
14
<script src="../js/darkfish.js" type="text/javascript" charset="utf-8">
17
<body id="top" class="class">
19
<div id="home-metadata">
20
<div id="home-section" class="section">
21
<h3 class="section-header"><a href="../index.html">Home</a> <a href="../index.html#classes">Classes</a> <a href="../index.html#methods">Methods</a></h3>
24
<div id="file-metadata">
25
<div id="file-list-section" class="section">
26
<h3 class="section-header">In Files</h3>
27
<div class="section-body">
29
<li><a href="../rdf/redland/serializer_rb.html?TB_iframe=true&height=550&width=785" class="thickbox" title="rdf/redland/serializer.rb">rdf/redland/serializer.rb</a></li>
34
<div id="class-metadata"><!-- Parent Class -->
35
<div id="parent-class-section" class="section">
36
<h3 class="section-header">Parent</h3>
37
<p class="link">Object</p>
39
<!-- Method Quickref -->
40
<div id="method-list-section" class="section">
41
<h3 class="section-header">Methods</h3>
42
<ul class="link-list">
43
<li><a href="#method-c-create_finalizer">::create_finalizer</a></li>
44
<li><a href="#method-c-new">::new</a></li>
45
<li><a href="#method-c-ntriples">::ntriples</a></li>
46
<li><a href="#method-i-feature">#feature</a></li>
47
<li><a href="#method-i-model_to_string">#model_to_string</a></li>
48
<li><a href="#method-i-setFeature">#setFeature</a></li>
49
<li><a href="#method-i-set_namespace">#set_namespace</a></li>
50
<li><a href="#method-i-to_file">#to_file</a></li>
54
<div id="project-metadata">
55
<div id="fileindex-section" class="section project-section">
56
<h3 class="section-header">Files</h3>
58
<li class="file"><a href="../Makefile.html">Makefile</a></li>
59
<li class="file"><a href="../rdf/Makefile.html">Makefile</a></li>
60
<li class="file"><a href="../rdf/redland/Makefile.html">Makefile</a></li>
61
<li class="file"><a href="../rdf/redland/schemas/Makefile.html">Makefile</a></li>
64
<div id="classindex-section" class="section project-section">
65
<h3 class="section-header">Class/Module Index <span class="search-toggle"><img src="../images/find.png" height="16" width="16" alt="[+]" title="show/hide quicksearch" /></span></h3>
66
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
67
<fieldset><legend>Quicksearch</legend> <input type="text" name="quicksearch" value="" class="quicksearch-field" /></fieldset>
69
<ul class="link-list">
70
<li><a href="../Redland.html">Redland</a></li>
71
<li><a href="../Redland/BNode.html">Redland::BNode</a></li>
72
<li><a href="../Redland/ContextParser.html">Redland::ContextParser</a></li>
73
<li><a href="../Redland/FileStore.html">Redland::FileStore</a></li>
74
<li><a href="../Redland/HashOpen.html">Redland::HashOpen</a></li>
75
<li><a href="../Redland/HashStore.html">Redland::HashStore</a></li>
76
<li><a href="../Redland/Literal.html">Redland::Literal</a></li>
77
<li><a href="../Redland/MemoryStore.html">Redland::MemoryStore</a></li>
78
<li><a href="../Redland/MergedModel.html">Redland::MergedModel</a></li>
79
<li><a href="../Redland/Model.html">Redland::Model</a></li>
80
<li><a href="../Redland/Namespace.html">Redland::Namespace</a></li>
81
<li><a href="../Redland/Node.html">Redland::Node</a></li>
82
<li><a href="../Redland/NodeIterator.html">Redland::NodeIterator</a></li>
83
<li><a href="../Redland/NodeTypeError.html">Redland::NodeTypeError</a></li>
84
<li><a href="../Redland/OWL.html">Redland::OWL</a></li>
85
<li><a href="../Redland/Parser.html">Redland::Parser</a></li>
86
<li><a href="../Redland/Query.html">Redland::Query</a></li>
87
<li><a href="../Redland/QueryResults.html">Redland::QueryResults</a></li>
88
<li><a href="../Redland/RDFS.html">Redland::RDFS</a></li>
89
<li><a href="../Redland/RedlandError.html">Redland::RedlandError</a></li>
90
<li><a href="../Redland/Resource.html">Redland::Resource</a></li>
91
<li><a href="../Redland/Serializer.html">Redland::Serializer</a></li>
92
<li><a href="../Redland/Statement.html">Redland::Statement</a></li>
93
<li><a href="../Redland/Stream.html">Redland::Stream</a></li>
94
<li><a href="../Redland/TripleStore.html">Redland::TripleStore</a></li>
95
<li><a href="../Redland/Uri.html">Redland::Uri</a></li>
96
<li><a href="../Redland/Util.html">Redland::Util</a></li>
97
<li><a href="../Redland/World.html">Redland::World</a></li>
98
<li><a href="../DC.html">DC</a></li>
99
<li><a href="../FOAF.html">FOAF</a></li>
101
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
105
<div id="documentation">
106
<h1 class="class">Redland::Serializer</h1>
107
<div id="description" class="description">
108
<p>This module provides RDF graph to syntax serialization support via factory classes providing one or more particular target syntaxes.</p>
111
<div id="5Buntitled-5D" class="documentation-section"><!-- Methods -->
112
<div id="public-class-method-details" class="method-section section">
113
<h3 class="section-header">Public Class Methods</h3>
114
<div id="create_finalizer-method" class="method-detail"><a name="method-c-create_finalizer" id="method-c-create_finalizer"></a>
115
<div class="method-heading"><span class="method-name">create_finalizer</span><span class="method-args">(serializer)</span> <span class="method-click-advice">click to toggle source</span></div>
116
<div class="method-description">
117
<p>You shouldn't use this. Used internally for cleanup.</p>
118
<div class="method-source-code" id="create_finalizer-source">
120
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 26</span>
121
<span class="ruby-keyword">def</span> <span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">create_finalizer</span>(<span class="ruby-identifier">serializer</span>)
122
<span class="ruby-identifier">proc</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span> <span class="ruby-comment"># "Finalizer on #{id}"</span>
123
<span class="ruby-comment">#log_final.info "closing serializer"</span>
124
<span class="ruby-constant">Redland</span><span class="ruby-operator">::</span><span class="ruby-identifier">librdf_free_serializer</span>(<span class="ruby-identifier">serializer</span>)
126
<span class="ruby-keyword">end</span>
128
<!-- create_finalizer-source --></div>
130
<!-- create_finalizer-method -->
131
<div id="new-method" class="method-detail"><a name="method-c-new" id="method-c-new"></a>
132
<div class="method-heading"><span class="method-name">new</span><span class="method-args">(name='rdfxml',mime_type="application/rdf+xml",uri=nil)</span> <span class="method-click-advice">click to toggle source</span></div>
133
<div class="method-description">
134
<p>Constructor - create a new <a href="Serializer.html">Serializer</a> object name - the serializer factory name mime_type - the MIME type of the syntax uri - URI of syntax</p>
135
<div class="method-source-code" id="new-source">
137
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 12</span>
138
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>=<span class="ruby-string">'rdfxml'</span>,<span class="ruby-identifier">mime_type</span>=<span class="ruby-string">"application/rdf+xml"</span>,<span class="ruby-identifier">uri</span>=<span class="ruby-keyword">nil</span>)
139
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">uri</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>
140
<span class="ruby-ivar">@serializer</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_new_serializer</span>(<span class="ruby-identifier">$world</span>.<span class="ruby-identifier">world</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">mime_type</span>,<span class="ruby-identifier">uri</span>)
141
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RedlandError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Serializer construction failed"</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@serializer</span>
142
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-keyword">self</span>,<span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">create_finalizer</span>(<span class="ruby-ivar">@serializer</span>))
143
<span class="ruby-keyword">end</span>
145
<!-- new-source --></div>
148
<div id="ntriples-method" class="method-detail"><a name="method-c-ntriples" id="method-c-ntriples"></a>
149
<div class="method-heading"><span class="method-name">ntriples</span><span class="method-args">(uri=nil)</span> <span class="method-click-advice">click to toggle source</span></div>
150
<div class="method-description">
151
<p>Create a NTriples serializer uri - URI of syntax</p>
152
<div class="method-source-code" id="ntriples-source">
154
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 21</span>
155
<span class="ruby-keyword">def</span> <span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">ntriples</span>(<span class="ruby-identifier">uri</span>=<span class="ruby-keyword">nil</span>)
156
<span class="ruby-keyword">return</span> <span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'ntriples'</span>,<span class="ruby-string">'text/plain'</span>,<span class="ruby-identifier">uri</span>)
157
<span class="ruby-keyword">end</span>
159
<!-- ntriples-source --></div>
161
<!-- ntriples-method --></div>
162
<!-- public-class-method-details -->
163
<div id="public-instance-method-details" class="method-section section">
164
<h3 class="section-header">Public Instance Methods</h3>
165
<div id="feature-method" class="method-detail"><a name="method-i-feature" id="method-i-feature"></a>
166
<div class="method-heading"><span class="method-name">feature</span><span class="method-args">(uri)</span> <span class="method-click-advice">click to toggle source</span></div>
167
<div class="method-description">
168
<p>Get a parser feature. The feature is named via RDF::Redland::URI I<URI></p>
169
<div class="method-source-code" id="feature-source">
171
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 46</span>
172
<span class="ruby-keyword">def</span> <span class="ruby-identifier">feature</span>(<span class="ruby-identifier">uri</span>)
173
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">Uri</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Uri</span>
174
<span class="ruby-identifier">value</span> = <span class="ruby-constant">Redland</span><span class="ruby-operator">::</span><span class="ruby-identifier">librdf_serializer_get_feature</span>(<span class="ruby-ivar">@serializer</span>,<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">uri</span>)
175
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-string">"NULL"</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">value</span><span class="ruby-operator">==</span><span class="ruby-keyword">nil</span>
176
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
177
<span class="ruby-keyword">else</span>
178
<span class="ruby-keyword">return</span> <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:from_object=</span><span class="ruby-operator">></span><span class="ruby-identifier">value</span>)
179
<span class="ruby-keyword">end</span>
180
<span class="ruby-keyword">end</span>
182
<!-- feature-source --></div>
184
<!-- feature-method -->
185
<div id="model_to_string-method" class="method-detail"><a name="method-i-model_to_string" id="method-i-model_to_string"></a>
186
<div class="method-heading"><span class="method-name">model_to_string</span><span class="method-args">(base_uri, model)</span> <span class="method-click-advice">click to toggle source</span></div>
187
<div class="method-description">
188
<p>Serialize the RDF graph in model to a string</p>
189
<div class="method-source-code" id="model_to_string-source">
191
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 71</span>
192
<span class="ruby-keyword">def</span> <span class="ruby-identifier">model_to_string</span>(<span class="ruby-identifier">base_uri</span>, <span class="ruby-identifier">model</span>)
193
<span class="ruby-keyword">if</span> <span class="ruby-identifier">base_uri</span>
194
<span class="ruby-identifier">base_uri</span> = <span class="ruby-identifier">base_uri</span>.<span class="ruby-identifier">uri</span>
195
<span class="ruby-keyword">end</span>
196
<span class="ruby-keyword">return</span> <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_serializer_serialize_model_to_string</span>(<span class="ruby-ivar">@serializer</span>, <span class="ruby-identifier">base_uri</span>, <span class="ruby-identifier">model</span>.<span class="ruby-identifier">model</span>)
197
<span class="ruby-keyword">end</span>
199
<!-- model_to_string-source --></div>
201
<!-- model_to_string-method -->
202
<div id="setFeature-method" class="method-detail"><a name="method-i-setFeature" id="method-i-setFeature"></a>
203
<div class="method-heading"><span class="method-name">setFeature</span><span class="method-args">(uri,value)</span> <span class="method-click-advice">click to toggle source</span></div>
204
<div class="method-description">
205
<p>Set a serializer feature. The feature is named via RDF::Redland::URI I<URI> and the value is a RDF::Redland::Node.</p>
206
<div class="method-source-code" id="setFeature-source">
208
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 58</span>
209
<span class="ruby-keyword">def</span> <span class="ruby-identifier">setFeature</span>(<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">value</span>)
210
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">Uri</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Uri</span>
211
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">value</span> = <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:literal=</span><span class="ruby-operator">></span><span class="ruby-identifier">value</span>) <span class="ruby-keyword">end</span>
212
<span class="ruby-keyword">return</span> (<span class="ruby-constant">Redland</span><span class="ruby-operator">::</span><span class="ruby-identifier">librdf_serializer_set_feature</span>(<span class="ruby-ivar">@serializer</span>,<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">value</span>.<span class="ruby-identifier">node</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>)
213
<span class="ruby-keyword">end</span>
215
<!-- setFeature-source --></div>
217
<!-- setFeature-method -->
218
<div id="set_namespace-method" class="method-detail"><a name="method-i-set_namespace" id="method-i-set_namespace"></a>
219
<div class="method-heading"><span class="method-name">set_namespace</span><span class="method-args">(prefix, uri)</span> <span class="method-click-advice">click to toggle source</span></div>
220
<div class="method-description">
221
<p>Set a serializer namepace to the desired prefix</p>
222
<div class="method-source-code" id="set_namespace-source">
224
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 65</span>
225
<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_namespace</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">uri</span>)
226
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">Uri</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Uri</span>
227
<span class="ruby-keyword">return</span> (<span class="ruby-constant">Redland</span><span class="ruby-operator">::</span><span class="ruby-identifier">librdf_serializer_set_namespace</span>(<span class="ruby-ivar">@serializer</span>,<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">prefix</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>)
228
<span class="ruby-keyword">end</span>
230
<!-- set_namespace-source --></div>
232
<!-- set_namespace-method -->
233
<div id="to_file-method" class="method-detail"><a name="method-i-to_file" id="method-i-to_file"></a>
234
<div class="method-heading"><span class="method-name">to_file</span><span class="method-args">(name,model,base_uri=nil)</span> <span class="method-click-advice">click to toggle source</span></div>
235
<div class="method-description">
236
<p>Serializes a model and stores it in a file name - the serializer factory name mime_type - the MIME type of the syntax base_uri - URI of syntax</p>
237
<div class="method-source-code" id="to_file-source">
239
<span class="ruby-comment"># File rdf/redland/serializer.rb, line 37</span>
240
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_file</span>(<span class="ruby-identifier">name</span>,<span class="ruby-identifier">model</span>,<span class="ruby-identifier">base_uri</span>=<span class="ruby-keyword">nil</span>)
241
<span class="ruby-keyword">if</span> <span class="ruby-identifier">base_uri</span>
242
<span class="ruby-identifier">base_uri</span> = <span class="ruby-identifier">base_uri</span>.<span class="ruby-identifier">uri</span>
243
<span class="ruby-keyword">end</span>
244
<span class="ruby-keyword">return</span> <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_serializer_serialize_model_to_file</span>(<span class="ruby-ivar">@serializer</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">base_uri</span>,<span class="ruby-identifier">model</span>.<span class="ruby-identifier">model</span>)
245
<span class="ruby-keyword">end</span>
247
<!-- to_file-source --></div>
249
<!-- to_file-method --></div>
250
<!-- public-instance-method-details --></div>
251
<!-- 5Buntitled-5D --></div>
252
<!-- documentation -->
255
<div class="outerHeader">
256
Go to <a href="/" target="_parent">Redland Home</a> -
257
<a href="/bindings/" target="_parent">Language Bindings Home</a> -
258
<a href="/docs/ruby.html" target="_parent">Ruby API Home</a>
261
<p>(C) Copyright 2004-2013 <a href="http://www.dajobe.org/" target="_parent">Dave Beckett</a>, (C) Copyright 2004-2005 <a href="http://www.bristol.ac.uk/" target="_parent">University of Bristol</a></p>
263
</div> <!-- end outerBlock -->
added
removed
docs/rdoc/Redland/Serializer.html
