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

« back to all changes in this revision

Viewing changes to docs/rdoc/Redland/Literal.html

  • Committer: Package Import Robot
  • Author(s): Dave Beckett
  • Date: 2013-01-22 16:03:44 UTC
  • mfrom: (0.1.10)
  • Revision ID: package-import@ubuntu.com-20130122160344-vxrnfl0xynfzbze7
Tags: 1.0.16.1-1
* New upstream release
* Add dpkg-buildflags to configure for hardening

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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">
 
5
<head>
 
6
<title>Redland RDF Language Bindings - Ruby RDoc - Class: Redland::Literal</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">
 
9
</script>
 
10
<script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8">
 
11
</script>
 
12
<script src="../js/quicksearch.js" type="text/javascript" charset="utf-8">
 
13
</script>
 
14
<script src="../js/darkfish.js" type="text/javascript" charset="utf-8">
 
15
</script>
 
16
</head>
 
17
<body id="top" class="class">
 
18
<div id="metadata">
 
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>
 
22
</div>
 
23
</div>
 
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">
 
28
<ul>
 
29
<li><a href="../rdf/redland/node_rb.html?TB_iframe=true&amp;height=550&amp;width=785" class="thickbox" title="rdf/redland/node.rb">rdf/redland/node.rb</a></li>
 
30
</ul>
 
31
</div>
 
32
</div>
 
33
</div>
 
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"><a href="Node.html">Redland::Node</a></p>
 
38
</div>
 
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-from_node">::from_node</a></li>
 
44
<li><a href="#method-c-from_xml">::from_xml</a></li>
 
45
<li><a href="#method-c-new">::new</a></li>
 
46
</ul>
 
47
</div>
 
48
<!-- Included Modules -->
 
49
<div id="includes-section" class="section">
 
50
<h3 class="section-header">Included Modules</h3>
 
51
<ul class="link-list">
 
52
<li><a class="include" href="../Redland.html">Redland</a></li>
 
53
</ul>
 
54
</div>
 
55
</div>
 
56
<div id="project-metadata">
 
57
<div id="fileindex-section" class="section project-section">
 
58
<h3 class="section-header">Files</h3>
 
59
<ul>
 
60
<li class="file"><a href="../Makefile.html">Makefile</a></li>
 
61
<li class="file"><a href="../rdf/Makefile.html">Makefile</a></li>
 
62
<li class="file"><a href="../rdf/redland/Makefile.html">Makefile</a></li>
 
63
<li class="file"><a href="../rdf/redland/schemas/Makefile.html">Makefile</a></li>
 
64
</ul>
 
65
</div>
 
66
<div id="classindex-section" class="section project-section">
 
67
<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>
 
68
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 
69
<fieldset><legend>Quicksearch</legend> <input type="text" name="quicksearch" value="" class="quicksearch-field" /></fieldset>
 
70
</form>
 
71
<ul class="link-list">
 
72
<li><a href="../Redland.html">Redland</a></li>
 
73
<li><a href="../Redland/BNode.html">Redland::BNode</a></li>
 
74
<li><a href="../Redland/ContextParser.html">Redland::ContextParser</a></li>
 
75
<li><a href="../Redland/FileStore.html">Redland::FileStore</a></li>
 
76
<li><a href="../Redland/HashOpen.html">Redland::HashOpen</a></li>
 
77
<li><a href="../Redland/HashStore.html">Redland::HashStore</a></li>
 
78
<li><a href="../Redland/Literal.html">Redland::Literal</a></li>
 
79
<li><a href="../Redland/MemoryStore.html">Redland::MemoryStore</a></li>
 
80
<li><a href="../Redland/MergedModel.html">Redland::MergedModel</a></li>
 
81
<li><a href="../Redland/Model.html">Redland::Model</a></li>
 
82
<li><a href="../Redland/Namespace.html">Redland::Namespace</a></li>
 
83
<li><a href="../Redland/Node.html">Redland::Node</a></li>
 
84
<li><a href="../Redland/NodeIterator.html">Redland::NodeIterator</a></li>
 
85
<li><a href="../Redland/NodeTypeError.html">Redland::NodeTypeError</a></li>
 
86
<li><a href="../Redland/OWL.html">Redland::OWL</a></li>
 
87
<li><a href="../Redland/Parser.html">Redland::Parser</a></li>
 
88
<li><a href="../Redland/Query.html">Redland::Query</a></li>
 
89
<li><a href="../Redland/QueryResults.html">Redland::QueryResults</a></li>
 
90
<li><a href="../Redland/RDFS.html">Redland::RDFS</a></li>
 
91
<li><a href="../Redland/RedlandError.html">Redland::RedlandError</a></li>
 
92
<li><a href="../Redland/Resource.html">Redland::Resource</a></li>
 
93
<li><a href="../Redland/Serializer.html">Redland::Serializer</a></li>
 
94
<li><a href="../Redland/Statement.html">Redland::Statement</a></li>
 
95
<li><a href="../Redland/Stream.html">Redland::Stream</a></li>
 
96
<li><a href="../Redland/TripleStore.html">Redland::TripleStore</a></li>
 
97
<li><a href="../Redland/Uri.html">Redland::Uri</a></li>
 
98
<li><a href="../Redland/Util.html">Redland::Util</a></li>
 
99
<li><a href="../Redland/World.html">Redland::World</a></li>
 
100
<li><a href="../DC.html">DC</a></li>
 
101
<li><a href="../FOAF.html">FOAF</a></li>
 
102
</ul>
 
103
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
 
104
</div>
 
105
</div>
 
106
</div>
 
107
<div id="documentation">
 
108
<h1 class="class">Redland::Literal</h1>
 
109
<div id="description" class="description">
 
110
<p>A literal node</p>
 
111
</div>
 
112
<!-- description -->
 
113
<div id="5Buntitled-5D" class="documentation-section"><!-- Attributes -->
 
114
<div id="attribute-method-details" class="method-section section">
 
115
<h3 class="section-header">Attributes</h3>
 
116
<div id="language-attribute-method" class="method-detail"><a name="language" id="language"></a>
 
117
<div class="method-heading attribute-method-heading"><span class="method-name">language</span><span class="attribute-access-type">[R]</span></div>
 
118
<div class="method-description">
 
119
<p>the language of the literal</p>
 
120
</div>
 
121
</div>
 
122
<div id="value-attribute-method" class="method-detail"><a name="value" id="value"></a>
 
123
<div class="method-heading attribute-method-heading"><span class="method-name">value</span><span class="attribute-access-type">[R]</span></div>
 
124
<div class="method-description">
 
125
<p>the string value of the literal</p>
 
126
</div>
 
127
</div>
 
128
</div>
 
129
<!-- attribute-method-details -->
 
130
<!-- Methods -->
 
131
<div id="public-class-method-details" class="method-section section">
 
132
<h3 class="section-header">Public Class Methods</h3>
 
133
<div id="from_node-method" class="method-detail"><a name="method-c-from_node" id="method-c-from_node"></a>
 
134
<div class="method-heading"><span class="method-name">from_node</span><span class="method-args">(node)</span> <span class="method-click-advice">click to toggle source</span></div>
 
135
<div class="method-description">
 
136
<p>create a literal from another <a href="Node.html">Node</a></p>
 
137
<div class="method-source-code" id="from_node-source">
 
138
<pre>
 
139
<span class="ruby-comment"># File rdf/redland/node.rb, line 246</span>
 
140
<span class="ruby-keyword">def</span> <span class="ruby-constant">Literal</span>.<span class="ruby-identifier">from_node</span>(<span class="ruby-identifier">node</span>)
 
141
  <span class="ruby-identifier">lang</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_node_get_literal_value_language</span>(<span class="ruby-identifier">node</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_node_get_literal_value_language</span>(<span class="ruby-identifier">node</span>)
 
142
  <span class="ruby-identifier">str</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_node_get_literal_value</span>(<span class="ruby-identifier">node</span>)
 
143
  <span class="ruby-identifier">hash_uri</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_node_get_literal_value_datatype_uri</span>(<span class="ruby-identifier">node</span>)
 
144
  <span class="ruby-identifier">hash_uri</span> = <span class="ruby-constant">Uri</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_uri_to_string</span>(<span class="ruby-identifier">hash_uri</span>)) <span class="ruby-keyword">if</span> <span class="ruby-identifier">hash_uri</span>
 
145
  <span class="ruby-keyword">return</span> <span class="ruby-constant">Literal</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">str</span>,<span class="ruby-identifier">lang</span>,<span class="ruby-identifier">hash_uri</span>)
 
146
<span class="ruby-keyword">end</span>
 
147
</pre></div>
 
148
<!-- from_node-source --></div>
 
149
</div>
 
150
<!-- from_node-method -->
 
151
<div id="from_xml-method" class="method-detail"><a name="method-c-from_xml" id="method-c-from_xml"></a>
 
152
<div class="method-heading"><span class="method-name">from_xml</span><span class="method-args">(str,lang=nil)</span> <span class="method-click-advice">click to toggle source</span></div>
 
153
<div class="method-description">
 
154
<p>create a literal from and xml string</p>
 
155
<pre>
 
156
literal = Literal.from_xml('&lt;em&gt;This is emphasized&lt;/em&gt;')
 
157
</pre>
 
158
<div class="method-source-code" id="from_xml-source">
 
159
<pre>
 
160
<span class="ruby-comment"># File rdf/redland/node.rb, line 256</span>
 
161
<span class="ruby-keyword">def</span> <span class="ruby-constant">Literal</span>.<span class="ruby-identifier">from_xml</span>(<span class="ruby-identifier">str</span>,<span class="ruby-identifier">lang</span>=<span class="ruby-keyword">nil</span>)
 
162
  <span class="ruby-keyword">return</span> <span class="ruby-constant">Literal</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">str</span>,<span class="ruby-identifier">lang</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">true</span>)
 
163
<span class="ruby-keyword">end</span>
 
164
</pre></div>
 
165
<!-- from_xml-source --></div>
 
166
</div>
 
167
<!-- from_xml-method -->
 
168
<div id="new-method" class="method-detail"><a name="method-c-new" id="method-c-new"></a>
 
169
<div class="method-heading"><span class="method-name">new</span><span class="method-args">(str,lang=nil,uri=nil,is_xml=false)</span> <span class="method-click-advice">click to toggle source</span></div>
 
170
<div class="method-description">
 
171
<p>create a new <a href="Literal.html">Literal</a> node</p>
 
172
<pre>
 
173
literal = Literal.new('Dominic')
 
174
label = Literal.new('Name','en')
 
175
</pre>
 
176
<div class="method-source-code" id="new-source">
 
177
<pre>
 
178
<span class="ruby-comment"># File rdf/redland/node.rb, line 231</span>
 
179
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">str</span>,<span class="ruby-identifier">lang</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">uri</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">is_xml</span>=<span class="ruby-keyword">false</span>)
 
180
  <span class="ruby-ivar">@value</span> = <span class="ruby-identifier">str</span>
 
181
  <span class="ruby-ivar">@language</span> = <span class="ruby-identifier">lang</span>
 
182
  <span class="ruby-identifier">is_xml</span> = <span class="ruby-identifier">is_xml</span><span class="ruby-operator">==</span><span class="ruby-keyword">true</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
 
183
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>
 
184
    <span class="ruby-ivar">@node</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_new_node_from_typed_literal</span>(<span class="ruby-identifier">$world</span>.<span class="ruby-identifier">world</span>,<span class="ruby-identifier">value</span>,<span class="ruby-identifier">lang</span>,<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">uri</span>)
 
185
  <span class="ruby-keyword">else</span>
 
186
    <span class="ruby-ivar">@node</span> = <span class="ruby-constant">Redland</span>.<span class="ruby-identifier">librdf_new_node_from_literal</span>(<span class="ruby-identifier">$world</span>.<span class="ruby-identifier">world</span>,<span class="ruby-identifier">value</span>,<span class="ruby-identifier">lang</span>,<span class="ruby-identifier">is_xml</span>)
 
187
  <span class="ruby-keyword">end</span>
 
188
 
 
189
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">RedlandError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Node construction failed"</span>) <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@node</span>
 
190
  <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-keyword">self</span>,<span class="ruby-constant">Node</span>.<span class="ruby-identifier">create_finalizer</span>(<span class="ruby-ivar">@node</span>))
 
191
<span class="ruby-keyword">end</span>
 
192
</pre></div>
 
193
<!-- new-source --></div>
 
194
</div>
 
195
<!-- new-method --></div>
 
196
<!-- public-class-method-details --></div>
 
197
<!-- 5Buntitled-5D --></div>
 
198
<!-- documentation -->
 
199
<hr />
 
200
 
 
201
<div class="outerHeader">
 
202
Go to <a href="/" target="_parent">Redland Home</a> - 
 
203
<a href="/bindings/" target="_parent">Language Bindings Home</a> - 
 
204
<a href="/docs/ruby.html" target="_parent">Ruby API Home</a>
 
205
</div>
 
206
 
 
207
<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>
 
208
 
 
209
</div> <!-- end outerBlock -->
 
210
 
 
211
</body>
 
212
</html>