~ubuntu-branches/debian/squeeze/redland-bindings/squeeze

« back to all changes in this revision

Viewing changes to docs/rdoc/classes/Redland/Serializer.html

  • Committer: Bazaar Package Importer
  • Author(s): Dave Beckett
  • Date: 2009-04-07 00:24:21 UTC
  • mfrom: (0.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20090407002421-dce2r4otm5vqtheg
Tags: 1.0.8.1-2
* Use new sections ruby, php for librdf-ruby and php5-librdf respectively.
* Merge features from ubuntu packaging.  Thanks to Matthias Klose
  (not taking linker -Wl,--as-needed since that makes dyloading fail
  to pull in raptor symbols):
  debian/rules:
  - get python lib dir from distutils
  - make dh_pycentral use symlinks
  debian/python-librdf.examples:
  - add data/dc.rdf to examples dir and adjust example.py
    to point to it (Closes: #402612)
* Patch python/Makefile.in so it can allow the include dir to be
  overridden by the particular python version build in debian/rules
  using PYTHON_INCLUDES

Show diffs side-by-side

added added

removed removed

Lines of Context:
71
71
</div>
72
72
<div id="method-list">
73
73
<h3 class="section-bar">Methods</h3>
74
 
<div class="name-list"><a href="#M000021">create_finalizer</a>&nbsp;&nbsp; <a href="#M000023">feature</a>&nbsp;&nbsp; <a href="#M000024">feature=</a>&nbsp;&nbsp; <a href="#M000026">model_to_string</a>&nbsp;&nbsp; <a href="#M000019">new</a>&nbsp;&nbsp; <a href="#M000020">ntriples</a>&nbsp;&nbsp; <a href="#M000025">set_namespace</a>&nbsp;&nbsp; <a href="#M000022">to_file</a>&nbsp;&nbsp;</div>
 
74
<div class="name-list"><a href="#M000159">create_finalizer</a>&nbsp;&nbsp; <a href="#M000161">feature</a>&nbsp;&nbsp; <a href="#M000164">model_to_string</a>&nbsp;&nbsp; <a href="#M000157">new</a>&nbsp;&nbsp; <a href="#M000158">ntriples</a>&nbsp;&nbsp; <a href="#M000162">setFeature</a>&nbsp;&nbsp; <a href="#M000163">set_namespace</a>&nbsp;&nbsp; <a href="#M000160">to_file</a>&nbsp;&nbsp;</div>
75
75
</div>
76
76
</div>
77
77
<!-- if includes -->
78
78
<div id="section"><!-- if method_list -->
79
79
<div id="methods">
80
80
<h3 class="section-bar">Public Class methods</h3>
81
 
<div id="method-M000021" class="method-detail"><a name="M000021" id="M000021"></a>
82
 
<div class="method-heading"><a href="#M000021" class="method-signature"><span class="method-name">create_finalizer</span><span class="method-args">(serializer)</span></a></div>
 
81
<div id="method-M000159" class="method-detail"><a name="M000159" id="M000159"></a>
 
82
<div class="method-heading"><a href="#M000159" class="method-signature"><span class="method-name">create_finalizer</span><span class="method-args">(serializer)</span></a></div>
83
83
<div class="method-description">
84
84
<p>You shouldn&lsquo;t use this. Used internally for cleanup.</p>
85
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
86
 
<div class="method-source-code" id="M000021-source">
 
85
<p><a class="source-toggle" href="#" onclick="toggleCode('M000159-source');return false;">[Source]</a></p>
 
86
<div class="method-source-code" id="M000159-source">
87
87
<pre>
88
88
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 26</span>
89
89
    <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">create_finalizer</span>(<span class="ruby-identifier">serializer</span>)
90
90
      <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-node">"Finalizer on #{id}"</span>
91
 
        <span class="ruby-identifier">log_final</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"closing serializer"</span>
 
91
        <span class="ruby-comment cmt">#log_final.info "closing serializer"</span>
92
92
        <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>)
93
93
      }
94
94
    <span class="ruby-keyword kw">end</span>
95
95
</pre></div>
96
96
</div>
97
97
</div>
98
 
<div id="method-M000019" class="method-detail"><a name="M000019" id="M000019"></a>
99
 
<div class="method-heading"><a href="#M000019" class="method-signature"><span class="method-name">new</span><span class="method-args">(name='rdfxml',mime_type="application/rdf+xml",uri=nil)</span></a></div>
 
98
<div id="method-M000157" class="method-detail"><a name="M000157" id="M000157"></a>
 
99
<div class="method-heading"><a href="#M000157" class="method-signature"><span class="method-name">new</span><span class="method-args">(name='rdfxml',mime_type="application/rdf+xml",uri=nil)</span></a></div>
100
100
<div class="method-description">
101
 
<p>Constructor - create a <a href="Serializer.html#M000019">new</a> <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>
102
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
103
 
<div class="method-source-code" id="M000019-source">
 
101
<p>Constructor - create a <a href="Serializer.html#M000157">new</a> <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>
 
102
<p><a class="source-toggle" href="#" onclick="toggleCode('M000157-source');return false;">[Source]</a></p>
 
103
<div class="method-source-code" id="M000157-source">
104
104
<pre>
105
105
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 12</span>
106
106
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>=<span class="ruby-value str">'rdfxml'</span>,<span class="ruby-identifier">mime_type</span>=<span class="ruby-value str">"application/rdf+xml"</span>,<span class="ruby-identifier">uri</span>=<span class="ruby-keyword kw">nil</span>)
112
112
</pre></div>
113
113
</div>
114
114
</div>
115
 
<div id="method-M000020" class="method-detail"><a name="M000020" id="M000020"></a>
116
 
<div class="method-heading"><a href="#M000020" class="method-signature"><span class="method-name">ntriples</span><span class="method-args">(uri=nil)</span></a></div>
 
115
<div id="method-M000158" class="method-detail"><a name="M000158" id="M000158"></a>
 
116
<div class="method-heading"><a href="#M000158" class="method-signature"><span class="method-name">ntriples</span><span class="method-args">(uri=nil)</span></a></div>
117
117
<div class="method-description">
118
118
<p>Create a NTriples serializer uri - URI of syntax</p>
119
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
120
 
<div class="method-source-code" id="M000020-source">
 
119
<p><a class="source-toggle" href="#" onclick="toggleCode('M000158-source');return false;">[Source]</a></p>
 
120
<div class="method-source-code" id="M000158-source">
121
121
<pre>
122
122
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 21</span>
123
123
    <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Serializer</span>.<span class="ruby-identifier">ntriples</span>(<span class="ruby-identifier">uri</span>=<span class="ruby-keyword kw">nil</span>)
127
127
</div>
128
128
</div>
129
129
<h3 class="section-bar">Public Instance methods</h3>
130
 
<div id="method-M000023" class="method-detail"><a name="M000023" id="M000023"></a>
131
 
<div class="method-heading"><a href="#M000023" class="method-signature"><span class="method-name">feature</span><span class="method-args">(uri)</span></a></div>
 
130
<div id="method-M000161" class="method-detail"><a name="M000161" id="M000161"></a>
 
131
<div class="method-heading"><a href="#M000161" class="method-signature"><span class="method-name">feature</span><span class="method-args">(uri)</span></a></div>
132
132
<div class="method-description">
133
 
<p>Get a parser <a href="Serializer.html#M000023">feature</a>. The <a href="Serializer.html#M000023">feature</a> is named via RDF::Redland::URI I&lt;URI&gt;</p>
134
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
135
 
<div class="method-source-code" id="M000023-source">
 
133
<p>Get a parser <a href="Serializer.html#M000161">feature</a>. The <a href="Serializer.html#M000161">feature</a> is named via RDF::Redland::URI I&lt;URI&gt;</p>
 
134
<p><a class="source-toggle" href="#" onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
 
135
<div class="method-source-code" id="M000161-source">
136
136
<pre>
137
137
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 46</span>
138
138
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">feature</span>(<span class="ruby-identifier">uri</span>)
141
141
      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"NULL"</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">value</span><span class="ruby-operator">==</span><span class="ruby-keyword kw">nil</span>
142
142
        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
143
143
      <span class="ruby-keyword kw">else</span>
144
 
        <span class="ruby-keyword kw">return</span> <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:from_object=</span><span class="ruby-operator">&gt;</span><span class="ruby-value str">'value'</span>)
 
144
        <span class="ruby-keyword kw">return</span> <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:from_object=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">value</span>)
145
145
      <span class="ruby-keyword kw">end</span>
146
146
    <span class="ruby-keyword kw">end</span>
147
147
</pre></div>
148
148
</div>
149
149
</div>
150
 
<div id="method-M000024" class="method-detail"><a name="M000024" id="M000024"></a>
151
 
<div class="method-heading"><a href="#M000024" class="method-signature"><span class="method-name">feature=</span><span class="method-args">(uri,value)</span></a></div>
152
 
<div class="method-description">
153
 
<p>Set a serializer <a href="Serializer.html#M000023">feature</a>. The <a href="Serializer.html#M000023">feature</a> is named via RDF::Redland::URI I&lt;URI&gt; and the value is a RDF::Redland::Node.</p>
154
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
155
 
<div class="method-source-code" id="M000024-source">
156
 
<pre>
157
 
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 58</span>
158
 
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">feature=</span>(<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">value</span>)
159
 
      <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 kw">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>
160
 
      <span class="ruby-keyword kw">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 kw">then</span> <span class="ruby-identifier">value</span> = <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:literal=</span><span class="ruby-operator">&gt;</span><span class="ruby-value str">'value'</span>) <span class="ruby-keyword kw">end</span>
161
 
      <span class="ruby-keyword kw">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>)
162
 
    <span class="ruby-keyword kw">end</span>
163
 
</pre></div>
164
 
</div>
165
 
</div>
166
 
<div id="method-M000026" class="method-detail"><a name="M000026" id="M000026"></a>
167
 
<div class="method-heading"><a href="#M000026" class="method-signature"><span class="method-name">model_to_string</span><span class="method-args">(base_uri, model)</span></a></div>
 
150
<div id="method-M000164" class="method-detail"><a name="M000164" id="M000164"></a>
 
151
<div class="method-heading"><a href="#M000164" class="method-signature"><span class="method-name">model_to_string</span><span class="method-args">(base_uri, model)</span></a></div>
168
152
<div class="method-description">
169
153
<p>Serialize the RDF graph in model to a string</p>
170
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
171
 
<div class="method-source-code" id="M000026-source">
 
154
<p><a class="source-toggle" href="#" onclick="toggleCode('M000164-source');return false;">[Source]</a></p>
 
155
<div class="method-source-code" id="M000164-source">
172
156
<pre>
173
157
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 71</span>
174
158
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">model_to_string</span>(<span class="ruby-identifier">base_uri</span>, <span class="ruby-identifier">model</span>)
175
 
      <span class="ruby-identifier">base_uri</span> = <span class="ruby-identifier">base_uri</span>.<span class="ruby-identifier">uri</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">base_uri</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
 
159
      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">base_uri</span>
 
160
        <span class="ruby-identifier">base_uri</span> = <span class="ruby-identifier">base_uri</span>.<span class="ruby-identifier">uri</span>
 
161
      <span class="ruby-keyword kw">end</span>
176
162
      <span class="ruby-keyword kw">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>)
177
163
    <span class="ruby-keyword kw">end</span>
178
164
</pre></div>
179
165
</div>
180
166
</div>
181
 
<div id="method-M000025" class="method-detail"><a name="M000025" id="M000025"></a>
182
 
<div class="method-heading"><a href="#M000025" class="method-signature"><span class="method-name">set_namespace</span><span class="method-args">(prefix, uri)</span></a></div>
 
167
<div id="method-M000162" class="method-detail"><a name="M000162" id="M000162"></a>
 
168
<div class="method-heading"><a href="#M000162" class="method-signature"><span class="method-name">setFeature</span><span class="method-args">(uri,value)</span></a></div>
 
169
<div class="method-description">
 
170
<p>Set a serializer <a href="Serializer.html#M000161">feature</a>. The <a href="Serializer.html#M000161">feature</a> is named via RDF::Redland::URI I&lt;URI&gt; and the value is a RDF::Redland::Node.</p>
 
171
<p><a class="source-toggle" href="#" onclick="toggleCode('M000162-source');return false;">[Source]</a></p>
 
172
<div class="method-source-code" id="M000162-source">
 
173
<pre>
 
174
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 58</span>
 
175
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setFeature</span>(<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">value</span>)
 
176
      <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 kw">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>
 
177
      <span class="ruby-keyword kw">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 kw">then</span> <span class="ruby-identifier">value</span> = <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:literal=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">value</span>) <span class="ruby-keyword kw">end</span>
 
178
      <span class="ruby-keyword kw">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>)
 
179
    <span class="ruby-keyword kw">end</span>
 
180
</pre></div>
 
181
</div>
 
182
</div>
 
183
<div id="method-M000163" class="method-detail"><a name="M000163" id="M000163"></a>
 
184
<div class="method-heading"><a href="#M000163" class="method-signature"><span class="method-name">set_namespace</span><span class="method-args">(prefix, uri)</span></a></div>
183
185
<div class="method-description">
184
186
<p>Set a serializer namepace to the desired prefix</p>
185
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
186
 
<div class="method-source-code" id="M000025-source">
 
187
<p><a class="source-toggle" href="#" onclick="toggleCode('M000163-source');return false;">[Source]</a></p>
 
188
<div class="method-source-code" id="M000163-source">
187
189
<pre>
188
190
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 65</span>
189
191
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_namespace</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">uri</span>)
193
195
</pre></div>
194
196
</div>
195
197
</div>
196
 
<div id="method-M000022" class="method-detail"><a name="M000022" id="M000022"></a>
197
 
<div class="method-heading"><a href="#M000022" class="method-signature"><span class="method-name">to_file</span><span class="method-args">(name,model,base_uri=nil)</span></a></div>
 
198
<div id="method-M000160" class="method-detail"><a name="M000160" id="M000160"></a>
 
199
<div class="method-heading"><a href="#M000160" class="method-signature"><span class="method-name">to_file</span><span class="method-args">(name,model,base_uri=nil)</span></a></div>
198
200
<div class="method-description">
199
201
<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>
200
 
<p><a class="source-toggle" href="#" onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
201
 
<div class="method-source-code" id="M000022-source">
 
202
<p><a class="source-toggle" href="#" onclick="toggleCode('M000160-source');return false;">[Source]</a></p>
 
203
<div class="method-source-code" id="M000160-source">
202
204
<pre>
203
205
<span class="ruby-comment cmt"># File rdf/redland/serializer.rb, line 37</span>
204
206
    <span class="ruby-keyword kw">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 kw">nil</span>)
220
222
<a href="/docs/ruby.html" target="_parent">Ruby API Home</a>
221
223
</div>
222
224
 
223
 
<p>(C) Copyright 2004-2007 <a href="http://purl.org/net/dajobe/" target="_parent">Dave Beckett</a>, (C) Copyright 2004-2005 <a href="http://www.bristol.ac.uk/" target="_parent">University of Bristol</a></p>
 
225
<p>(C) Copyright 2004-2008 <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>
224
226
 
225
227
</div> <!-- end outerBlock -->
226
228