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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: SQLite3::Translator</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript" language="JavaScript">
<!--
function toggleSource( id )
{
var elem
var link
if( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
//-->
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Class</span><br />SQLite3::Translator</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../files/lib/sqlite3/translator_rb.html">lib/sqlite3/translator.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div id="contextContent">
<div class="description"><p>
The <a href="Translator.html">Translator</a> class encapsulates the logic
and callbacks necessary for converting string data to a value of some
specified type. Every <a href="Database.html">Database</a> instance may
have a <a href="Translator.html">Translator</a> instance, in order to
assist in type translation (Database#type_translation).
</p>
<p>
Further, applications may define their own custom type translation logic by
registering translator blocks with the corresponding database’s
translator instance (<a
href="Database.html#M000097">Database#translator</a>).
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000072">add_translator</a></li>
<li><a href="#M000071">new</a></li>
<li><a href="#M000073">translate</a></li>
</ul>
</div>
<div id="section">
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000071"></a><b>new</b>()
</div>
<div class="description">
<p>
Create a new <a href="Translator.html">Translator</a> instance. It will be
preinitialized with default translators for most SQL data types.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000071-source')" id="l_M000071-source">show source</a> ]</p>
<div id="M000071-source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/translator.rb, line 49</span>
49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
50: <span class="ruby-ivar">@translators</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">type</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">value</span> } )
51: <span class="ruby-identifier">register_default_translators</span>
52: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000072"></a><b>add_translator</b>( type ) {|type, value| ...}
</div>
<div class="description">
<p>
Add a new translator block, which will be invoked to process type
translations to the given type. The type should be an SQL datatype, and may
include parentheses (i.e., "VARCHAR(30)"). However, any
parenthetical information is stripped off and discarded, so type
translation decisions are made solely on the "base" type name.
</p>
<p>
The translator block itself should accept two parameters, "type"
and "value". In this case, the "type" is the full type
name (including parentheses), so the block itself may include logic for
changing how a type is translated based on the additional data. The
"value" parameter is the (string) data to convert.
</p>
<p>
The block should return the translated value.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000072-source')" id="l_M000072-source">show source</a> ]</p>
<div id="M000072-source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/translator.rb, line 67</span>
67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_translator</span>( <span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) <span class="ruby-comment cmt"># :yields: type, value</span>
68: <span class="ruby-ivar">@translators</span>[ <span class="ruby-identifier">type_name</span>( <span class="ruby-identifier">type</span> ) ] = <span class="ruby-identifier">block</span>
69: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000073"></a><b>translate</b>( type, value )
</div>
<div class="description">
<p>
Translate the given string value to a value of the given type. In the
absense of an installed translator block for the given type, the value
itself is always returned. Further, <tt>nil</tt> values are never
translated, and are always passed straight through regardless of the type
parameter.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000073-source')" id="l_M000073-source">show source</a> ]</p>
<div id="M000073-source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/translator.rb, line 75</span>
75: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">translate</span>( <span class="ruby-identifier">type</span>, <span class="ruby-identifier">value</span> )
76: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
77: <span class="ruby-ivar">@translators</span>[ <span class="ruby-identifier">type_name</span>( <span class="ruby-identifier">type</span> ) ].<span class="ruby-identifier">call</span>( <span class="ruby-identifier">type</span>, <span class="ruby-identifier">value</span> )
78: <span class="ruby-keyword kw">end</span>
79: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
