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

Annotation of /Sprout/ERDBTypeInteger.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (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 ERDBTypeInteger;
21 :    
22 :     use strict;
23 :     use Tracer;
24 :     use ERDB;
25 :     use base qw(ERDBType);
26 :    
27 :     =head1 ERDB Integer Type Definition
28 :    
29 :     =head2 Introduction
30 :    
31 :     This object represents the primitive data type for 32-bit signed integers. The
32 :     values range from -2147483648 to 2147483647.
33 :    
34 :     =head3 new
35 :    
36 :     my $et = ERDBTypeInteger->new();
37 :    
38 :     Construct a new ERDBTypeInteger descriptor.
39 :    
40 :     =cut
41 :    
42 :     sub new {
43 :     # Get the parameters.
44 :     my ($class) = @_;
45 :     # Create the ERDBTypeInteger object.
46 :     my $retVal = { };
47 :     # Bless and return it.
48 :     bless $retVal, $class;
49 :     return $retVal;
50 :     }
51 :    
52 :     =head2 Virtual Methods
53 :    
54 :     =head3 numeric
55 :    
56 :     my $flag = $et->numeric();
57 :    
58 :     Return TRUE if this is a numeric type and FALSE otherwise. The default is
59 :     FALSE.
60 :    
61 :     =cut
62 :    
63 :     sub numeric {
64 :     # Get the parameters.
65 :     my ($self) = @_;
66 :     # Return the result.
67 :     return 1;
68 :     }
69 :    
70 :     =head3 averageLength
71 :    
72 :     my $value = $et->averageLength();
73 :    
74 :     Return the average length of a data item of this field type when it is stored in the
75 :     database. This value is used to compute the expected size of a database table.
76 :    
77 :     =cut
78 :    
79 :     sub averageLength {
80 :     return 4;
81 :     }
82 :    
83 :     =head3 prettySortValue
84 :    
85 :     my $value = $et->prettySortValue();
86 :    
87 :     Number indicating where fields of this type should go in relation to other
88 :     fields. The value should be somewhere between C<1> and C<5>. A value outside
89 :     that range will make terrible things happen.
90 :    
91 :     =cut
92 :    
93 :     sub prettySortValue() {
94 :     return 1;
95 :     }
96 :    
97 :     =head3 validate
98 :    
99 :     my $okFlag = $et->validate($value);
100 :    
101 :     Return an error message if the specified value is invalid for this field type.
102 :    
103 :     The parameters are as follows.
104 :    
105 :     =over 4
106 :    
107 :     =item value
108 :    
109 :     Value of this type, for validation.
110 :    
111 :     =item RETURN
112 :    
113 :     Returns an empty string if the specified field is valid, and an error message
114 :     otherwise.
115 :    
116 :     =back
117 :    
118 :     =cut
119 :    
120 :     sub validate {
121 :     # Get the parameters.
122 :     my ($self, $value) = @_;
123 :     # Assume it's valid until we prove otherwise.
124 :     my $retVal = "";
125 :     if ($value =~ /\./) {
126 :     $retVal = "Integer values cannot have decimal points.";
127 :     } elsif (not $value =~ /^[+-]?\d+$/) {
128 :     $retVal = "Integer value is not numeric.";
129 :     } elsif ($value > 0x7FFFFFFF || $value <= -0x7FFFFFFF) {
130 :     $retVal = "Integer value is out of range.";
131 :     }
132 :     # Return the determination.
133 :     return $retVal;
134 :     }
135 :    
136 :     =head3 encode
137 :    
138 :     my $string = $et->encode($value, $mode);
139 :    
140 :     Encode a value of this field type for storage in the database (or in a database load
141 :     file.)
142 :    
143 :     The parameters are as follows.
144 :    
145 :     =over 4
146 :    
147 :     =item value
148 :    
149 :     Value of this type, for encoding.
150 :    
151 :     =item mode
152 :    
153 :     TRUE if the value is being encoding for placement in a load file, FALSE if it
154 :     is being encoded for use as an SQL statement parameter. In most cases, the
155 :     encoding is the same for both modes.
156 :    
157 :     =back
158 :    
159 :     =cut
160 :    
161 :     sub encode {
162 :     # Get the parameters.
163 :     my ($self, $value, $mode) = @_;
164 :     # Declare the return variable.
165 :     my $retVal = $value;
166 :     # Return the result.
167 :     return $retVal;
168 :     }
169 :    
170 :     =head3 decode
171 :    
172 :     my $value = $et->decode($string);
173 :    
174 :     Decode a string from the database into a value of this field type.
175 :    
176 :     The parameters are as follows.
177 :    
178 :     =over 4
179 :    
180 :     =item string
181 :    
182 :     String from the database to be decoded.
183 :    
184 :     =item RETURN
185 :    
186 :     Returns a value of the desired type.
187 :    
188 :     =back
189 :    
190 :     =cut
191 :    
192 :     sub decode {
193 :     # Get the parameters.
194 :     my ($self, $string) = @_;
195 :     # Declare the return variable.
196 :     my $retVal = $string;
197 :     # Return the result.
198 :     return $retVal;
199 :     }
200 :    
201 :     =head3 sqlType
202 :    
203 :     my $typeString = $et->sqlType();
204 :    
205 :     Return the SQL data type for this field type.
206 :    
207 :     =cut
208 :    
209 :     sub sqlType {
210 :     return "INT";
211 :     }
212 :    
213 :     =head3 indexMod
214 :    
215 :     my $length = $et->indexMod();
216 :    
217 :     Return the index modifier for this field type. The index modifier is the number of
218 :     characters to be indexed. If it is undefined, the field cannot be indexed. If it
219 :     is an empty string, the entire field is indexed. The default is an empty string.
220 :    
221 :     =cut
222 :    
223 :     sub indexMod {
224 :     return '';
225 :     }
226 :    
227 :     =head3 sortType
228 :    
229 :     my $letter = $et->sortType();
230 :    
231 :     Return the sorting type for this field type. The sorting type is C<n> for integers,
232 :     C<g> for floating-point numbers, and the empty string for character fields.
233 :     The default is the empty string.
234 :    
235 :     =cut
236 :    
237 :     sub sortType {
238 :     return "n";
239 :     }
240 :    
241 :     =head3 documentation
242 :    
243 :     my $docText = $et->documentation();
244 :    
245 :     Return the documentation text for this field type. This should be in TWiki markup
246 :     format, though HTML will also work.
247 :    
248 :     =cut
249 :    
250 :     sub documentation() {
251 :     return 'Standard signed integers, ranging from approximately -2 billion to 2 billion.';
252 :     }
253 :    
254 :     =head3 name
255 :    
256 :     my $name = $et->name();
257 :    
258 :     Return the name of this type, as it will appear in the XML database definition.
259 :    
260 :     =cut
261 :    
262 :     sub name() {
263 :     return "int";
264 :     }
265 :    
266 :     =head3 default
267 :    
268 :     my $defaultValue = $et->default();
269 :    
270 :     Default value to be used for fields of this type if no default value is
271 : parrello 1.2 specified in the database definition or in an L<ERDBLoadGroup/Put>
272 : parrello 1.1 call during a loader operation. The default is undefined, which means
273 :     an error will be thrown during the load.
274 :    
275 :     =cut
276 :    
277 :     sub default {
278 :     return 0;
279 :     }
280 :    
281 :     =head3 align
282 :    
283 :     my $alignment = $et->align();
284 :    
285 :     Return the display alignment for fields of this type: either C<left>, C<right>, or
286 :     C<center>. The default is C<left>.
287 :    
288 :     =cut
289 :    
290 :     sub align {
291 :     return 'right';
292 :     }
293 :    
294 :    
295 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3