[Bio] / Sprout / ERDBTypeFloat.pm Repository:
ViewVC logotype

Annotation of /Sprout/ERDBTypeFloat.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.6 - (view) (download) (as text)

1 : parrello 1.1 #!/usr/bin/perl -w
2 :    
3 :     #
4 :     # Copyright (c) 2003-2006 University of Chicago and Fellowship
5 :     # for Interpretations of Genomes. All Rights Reserved.
6 :     #
7 :     # This file is part of the SEED Toolkit.
8 :     #
9 :     # The SEED Toolkit is free software. You can redistribute
10 :     # it and/or modify it under the terms of the SEED Toolkit
11 :     # Public License.
12 :     #
13 :     # You should have received a copy of the SEED Toolkit Public License
14 :     # along with this program; if not write to the University of Chicago
15 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
16 :     # Genomes at veronika@thefig.info or download a copy from
17 :     # http://www.theseed.org/LICENSE.TXT.
18 :     #
19 :    
20 :     package ERDBTypeFloat;
21 :    
22 :     use strict;
23 :     use Tracer;
24 :     use ERDB;
25 :     use base qw(ERDBType);
26 :    
27 :     =head1 Double Precision Floating-Point Numeric Type Definition
28 :    
29 :     =head2 Introduction
30 :    
31 :     This object represents the primitive data type for IEEE 8-byte floating-point
32 :     numbers. The allowable values are -1.7976931348623157E+308 to
33 :     -2.2250738585072014E-308, 0, and 2.2250738585072014E-308 to
34 :     1.7976931348623157E+308.
35 :    
36 :    
37 :     =cut
38 :    
39 :     =head3 new
40 :    
41 :     my $et = ERDBTypeFloat->new();
42 :    
43 :     Construct a new ERDBTypeFloat object.
44 :    
45 :     =cut
46 :    
47 :     sub new {
48 :     # Get the parameters.
49 :     my ($class) = @_;
50 :     # Create the object.
51 :     my $retVal = { };
52 :     # Bless and return it.
53 :     bless $retVal, $class;
54 :     return $retVal;
55 :     }
56 :    
57 :     =head2 Virtual Methods
58 :    
59 :     =head3 numeric
60 :    
61 :     my $flag = $et->numeric();
62 :    
63 :     Return TRUE if this is a numeric type and FALSE otherwise. The default is
64 :     FALSE.
65 :    
66 :     =cut
67 :    
68 :     sub numeric {
69 :     # Get the parameters.
70 :     my ($self) = @_;
71 :     # Return the result.
72 :     return 1;
73 :     }
74 :    
75 : parrello 1.6 =head3 nullable
76 :    
77 :     my $flag = $et->nullable();
78 :    
79 :     Return TRUE if this type allows null-valued fields, else FALSE. The default is
80 :     FALSE.
81 :    
82 :     =cut
83 :    
84 :     sub nullable {
85 :     # Get the parameters.
86 :     my ($self) = @_;
87 :     # Return the result.
88 :     return 1;
89 :     }
90 :    
91 : parrello 1.1 =head3 averageLength
92 :    
93 :     my $value = $et->averageLength();
94 :    
95 :     Return the average length of a data item of this field type when it is stored in the
96 :     database. This value is used to compute the expected size of a database table.
97 :    
98 :     =cut
99 :    
100 :     sub averageLength {
101 :     return 8;
102 :     }
103 :    
104 :     =head3 prettySortValue
105 :    
106 :     my $value = $et->prettySortValue();
107 :    
108 :     Number indicating where fields of this type should go in relation to other
109 :     fields. The value should be somewhere between C<1> and C<5>. A value outside
110 :     that range will make terrible things happen.
111 :    
112 :     =cut
113 :    
114 :     sub prettySortValue() {
115 :     return 1;
116 :     }
117 :    
118 :     =head3 validate
119 :    
120 :     my $okFlag = $et->validate($value);
121 :    
122 :     Return an error message if the specified value is invalid for this field type.
123 :    
124 :     The parameters are as follows.
125 :    
126 :     =over 4
127 :    
128 :     =item value
129 :    
130 :     Value of this type, for validation.
131 :    
132 :     =item RETURN
133 :    
134 :     Returns an empty string if the specified field is valid, and an error message
135 :     otherwise.
136 :    
137 :     =back
138 :    
139 :     =cut
140 :    
141 :     sub validate {
142 :     # Get the parameters.
143 :     my ($self, $value) = @_;
144 :     # Assume it's valid until we prove otherwise.
145 :     my $retVal = "";
146 : parrello 1.3 if (not $value =~ /^[+-]?(?:\d+\.?|\d+\.\d+|\.\d+)(?:[Ee][+-]?\d+)?$/) {
147 : parrello 1.1 $retVal = "Floating-point value \"$value\" is not numeric.";
148 :     }
149 :     # Return the determination.
150 :     return $retVal;
151 :     }
152 :    
153 :     =head3 encode
154 :    
155 :     my $string = $et->encode($value, $mode);
156 :    
157 :     Encode a value of this field type for storage in the database (or in a database load
158 :     file.)
159 :    
160 :     The parameters are as follows.
161 :    
162 :     =over 4
163 :    
164 :     =item value
165 :    
166 :     Value of this type, for encoding.
167 :    
168 :     =item mode
169 :    
170 :     TRUE if the value is being encoding for placement in a load file, FALSE if it
171 :     is being encoded for use as an SQL statement parameter. In most cases, the
172 :     encoding is the same for both modes.
173 :    
174 :     =back
175 :    
176 :     =cut
177 :    
178 :     sub encode {
179 :     # Get the parameters.
180 :     my ($self, $value, $mode) = @_;
181 : parrello 1.6 # Get the value.
182 :     my $retVal = $value;
183 :     # If we are going into a load file and the value is NULL, convert it to an
184 :     # escape sequence.
185 :     if ($mode && ! defined $retVal) {
186 :     $retVal = "\\N";
187 :     }
188 : parrello 1.1 # Return the result.
189 : parrello 1.6 return $retVal;
190 : parrello 1.1 }
191 :    
192 :     =head3 decode
193 :    
194 :     my $value = $et->decode($string);
195 :    
196 :     Decode a string from the database into a value of this field type.
197 :    
198 :     The parameters are as follows.
199 :    
200 :     =over 4
201 :    
202 :     =item string
203 :    
204 :     String from the database to be decoded.
205 :    
206 :     =item RETURN
207 :    
208 :     Returns a value of the desired type.
209 :    
210 :     =back
211 :    
212 :     =cut
213 :    
214 :     sub decode {
215 :     # Get the parameters.
216 :     my ($self, $string) = @_;
217 :     # Declare the return variable.
218 :     # Return the result.
219 :     return $string;
220 :     }
221 :    
222 :     =head3 sqlType
223 :    
224 : parrello 1.5 my $typeString = $et->sqlType($dbh);
225 : parrello 1.1
226 :     Return the SQL data type for this field type.
227 :    
228 : parrello 1.5 =over 4
229 :    
230 :     =item dbh
231 :    
232 :     Open L<DBKernel> handle for the database in question. This is used when the
233 :     datatype may be different depending on the DBMS used.
234 :    
235 :     =item RETURN
236 :    
237 :     Returns the datatype string to be used when creating a field of this type in
238 :     an SQL table.
239 :    
240 :     =back
241 :    
242 : parrello 1.1 =cut
243 :    
244 :     sub sqlType {
245 :     return "DOUBLE PRECISION";
246 :     }
247 :    
248 :     =head3 indexMod
249 :    
250 :     my $length = $et->indexMod();
251 :    
252 :     Return the index modifier for this field type. The index modifier is the number of
253 :     characters to be indexed. If it is undefined, the field cannot be indexed. If it
254 :     is an empty string, the entire field is indexed. The default is an empty string.
255 :    
256 :     =cut
257 :    
258 :     sub indexMod {
259 :     return '';
260 :     }
261 :    
262 :     =head3 sortType
263 :    
264 :     my $letter = $et->sortType();
265 :    
266 :     Return the sorting type for this field type. The sorting type is C<n> for integers,
267 :     C<g> for floating-point numbers, and the empty string for character fields.
268 :     The default is the empty string.
269 :    
270 :     =cut
271 :    
272 :     sub sortType {
273 :     return "g";
274 :     }
275 :    
276 :     =head3 documentation
277 :    
278 :     my $docText = $et->documentation();
279 :    
280 :     Return the documentation text for this field type. This should be in TWiki markup
281 :     format, though HTML will also work.
282 :    
283 :     =cut
284 :    
285 :     sub documentation() {
286 :     return "Floating-point number, approximately 15 significant digits, from 10^-308 to 10^+308.";
287 :     }
288 :    
289 :     =head3 name
290 :    
291 :     my $name = $et->name();
292 :    
293 :     Return the name of this type, as it will appear in the XML database definition.
294 :    
295 :     =cut
296 :    
297 :     sub name() {
298 :     return "float";
299 :     }
300 :    
301 :     =head3 default
302 :    
303 :     my $defaultValue = $et->default();
304 :    
305 :     Default value to be used for fields of this type if no default value is
306 : parrello 1.4 specified in the database definition or in an L<ERDBLoadGroup/Put>
307 : parrello 1.1 call during a loader operation. The default is undefined, which means
308 :     an error will be thrown during the load.
309 :    
310 :     =cut
311 :    
312 :     sub default {
313 :     return 0;
314 :     }
315 :    
316 :     =head3 align
317 :    
318 :     my $alignment = $et->align();
319 :    
320 :     Return the display alignment for fields of this type: either C<left>, C<right>, or
321 :     C<center>. The default is C<left>.
322 :    
323 :     =cut
324 :    
325 :     sub align {
326 :     return 'center';
327 :     }
328 :    
329 :     =head3 html
330 :    
331 :     my $html = $et->html($value);
332 :    
333 :     Return the HTML for displaying the content of a field of this type in an output
334 :     table. The default is the raw value, html-escaped.
335 :    
336 :     =cut
337 :    
338 :     sub html {
339 :     my ($self, $value) = @_;
340 : parrello 1.6 my $retVal = "";
341 :     if (defined $value) {
342 :     $retVal = sprintf("%.8g", $value);
343 :     }
344 : parrello 1.1 return $retVal;
345 :     }
346 :    
347 :    
348 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3