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

Annotation of /Sprout/ERDBTypeFloat.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (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 :     =head3 averageLength
76 :    
77 :     my $value = $et->averageLength();
78 :    
79 :     Return the average length of a data item of this field type when it is stored in the
80 :     database. This value is used to compute the expected size of a database table.
81 :    
82 :     =cut
83 :    
84 :     sub averageLength {
85 :     return 8;
86 :     }
87 :    
88 :     =head3 prettySortValue
89 :    
90 :     my $value = $et->prettySortValue();
91 :    
92 :     Number indicating where fields of this type should go in relation to other
93 :     fields. The value should be somewhere between C<1> and C<5>. A value outside
94 :     that range will make terrible things happen.
95 :    
96 :     =cut
97 :    
98 :     sub prettySortValue() {
99 :     return 1;
100 :     }
101 :    
102 :     =head3 validate
103 :    
104 :     my $okFlag = $et->validate($value);
105 :    
106 :     Return an error message if the specified value is invalid for this field type.
107 :    
108 :     The parameters are as follows.
109 :    
110 :     =over 4
111 :    
112 :     =item value
113 :    
114 :     Value of this type, for validation.
115 :    
116 :     =item RETURN
117 :    
118 :     Returns an empty string if the specified field is valid, and an error message
119 :     otherwise.
120 :    
121 :     =back
122 :    
123 :     =cut
124 :    
125 :     sub validate {
126 :     # Get the parameters.
127 :     my ($self, $value) = @_;
128 :     # Assume it's valid until we prove otherwise.
129 :     my $retVal = "";
130 : parrello 1.3 if (not $value =~ /^[+-]?(?:\d+\.?|\d+\.\d+|\.\d+)(?:[Ee][+-]?\d+)?$/) {
131 : parrello 1.1 $retVal = "Floating-point value \"$value\" is not numeric.";
132 :     }
133 :     # Return the determination.
134 :     return $retVal;
135 :     }
136 :    
137 :     =head3 encode
138 :    
139 :     my $string = $et->encode($value, $mode);
140 :    
141 :     Encode a value of this field type for storage in the database (or in a database load
142 :     file.)
143 :    
144 :     The parameters are as follows.
145 :    
146 :     =over 4
147 :    
148 :     =item value
149 :    
150 :     Value of this type, for encoding.
151 :    
152 :     =item mode
153 :    
154 :     TRUE if the value is being encoding for placement in a load file, FALSE if it
155 :     is being encoded for use as an SQL statement parameter. In most cases, the
156 :     encoding is the same for both modes.
157 :    
158 :     =back
159 :    
160 :     =cut
161 :    
162 :     sub encode {
163 :     # Get the parameters.
164 :     my ($self, $value, $mode) = @_;
165 :     # Return the result.
166 :     return $value;
167 :     }
168 :    
169 :     =head3 decode
170 :    
171 :     my $value = $et->decode($string);
172 :    
173 :     Decode a string from the database into a value of this field type.
174 :    
175 :     The parameters are as follows.
176 :    
177 :     =over 4
178 :    
179 :     =item string
180 :    
181 :     String from the database to be decoded.
182 :    
183 :     =item RETURN
184 :    
185 :     Returns a value of the desired type.
186 :    
187 :     =back
188 :    
189 :     =cut
190 :    
191 :     sub decode {
192 :     # Get the parameters.
193 :     my ($self, $string) = @_;
194 :     # Declare the return variable.
195 :     # Return the result.
196 :     return $string;
197 :     }
198 :    
199 :     =head3 sqlType
200 :    
201 :     my $typeString = $et->sqlType();
202 :    
203 :     Return the SQL data type for this field type.
204 :    
205 :     =cut
206 :    
207 :     sub sqlType {
208 :     return "DOUBLE PRECISION";
209 :     }
210 :    
211 :     =head3 indexMod
212 :    
213 :     my $length = $et->indexMod();
214 :    
215 :     Return the index modifier for this field type. The index modifier is the number of
216 :     characters to be indexed. If it is undefined, the field cannot be indexed. If it
217 :     is an empty string, the entire field is indexed. The default is an empty string.
218 :    
219 :     =cut
220 :    
221 :     sub indexMod {
222 :     return '';
223 :     }
224 :    
225 :     =head3 sortType
226 :    
227 :     my $letter = $et->sortType();
228 :    
229 :     Return the sorting type for this field type. The sorting type is C<n> for integers,
230 :     C<g> for floating-point numbers, and the empty string for character fields.
231 :     The default is the empty string.
232 :    
233 :     =cut
234 :    
235 :     sub sortType {
236 :     return "g";
237 :     }
238 :    
239 :     =head3 documentation
240 :    
241 :     my $docText = $et->documentation();
242 :    
243 :     Return the documentation text for this field type. This should be in TWiki markup
244 :     format, though HTML will also work.
245 :    
246 :     =cut
247 :    
248 :     sub documentation() {
249 :     return "Floating-point number, approximately 15 significant digits, from 10^-308 to 10^+308.";
250 :     }
251 :    
252 :     =head3 name
253 :    
254 :     my $name = $et->name();
255 :    
256 :     Return the name of this type, as it will appear in the XML database definition.
257 :    
258 :     =cut
259 :    
260 :     sub name() {
261 :     return "float";
262 :     }
263 :    
264 :     =head3 default
265 :    
266 :     my $defaultValue = $et->default();
267 :    
268 :     Default value to be used for fields of this type if no default value is
269 :     specified in the database definition or in an [[ERDBLoadGroup#Put]]
270 :     call during a loader operation. The default is undefined, which means
271 :     an error will be thrown during the load.
272 :    
273 :     =cut
274 :    
275 :     sub default {
276 :     return 0;
277 :     }
278 :    
279 :     =head3 align
280 :    
281 :     my $alignment = $et->align();
282 :    
283 :     Return the display alignment for fields of this type: either C<left>, C<right>, or
284 :     C<center>. The default is C<left>.
285 :    
286 :     =cut
287 :    
288 :     sub align {
289 :     return 'center';
290 :     }
291 :    
292 :     =head3 html
293 :    
294 :     my $html = $et->html($value);
295 :    
296 :     Return the HTML for displaying the content of a field of this type in an output
297 :     table. The default is the raw value, html-escaped.
298 :    
299 :     =cut
300 :    
301 :     sub html {
302 :     my ($self, $value) = @_;
303 : parrello 1.2 my $retVal = sprintf("%.8g", $value);
304 : parrello 1.1 return $retVal;
305 :     }
306 :    
307 :    
308 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3