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

Annotation of /Sprout/ERDBTypeSemiBoolean.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 ERDBTypeSemiBoolean;
21 :    
22 :     use strict;
23 :     use Tracer;
24 :     use ERDB;
25 :     use CGI qw(-nosticky);
26 :     use base qw(ERDBType);
27 :    
28 :     =head1 ERDB Ternary Value Type Definition
29 :    
30 :     =head2 Introduction
31 :    
32 :     This data type allows a ternary boolean value: Yes, No, or Unknown. The value is
33 :     represented as a single character-- C<N>, C<Y>, or C<?>. The type sorts with the
34 :     unknown value first, then NO, then YES.
35 :    
36 :     =head2 Public Methods
37 :    
38 :     =head3 new
39 :    
40 :     my $et = ERDBTypeSemiBoolean->new();
41 :    
42 :     Construct a new ERDBTypeSemiBoolean descriptor.
43 :    
44 :     =cut
45 :    
46 :     sub new {
47 :     # Get the parameters.
48 :     my ($class) = @_;
49 :     # Create the ERDBTypeSemiBoolean object.
50 :     my $retVal = { };
51 :     # Bless and return it.
52 :     bless $retVal, $class;
53 :     return $retVal;
54 :     }
55 :    
56 :     =head3 ComputeFromString
57 :    
58 :     my $char = ERDBTypeSemiBoolean::ComputeFromString($string);
59 :    
60 :     Compute a ternary value from a string. C<1>, C<y>, C<t>, C<true> and C<yes>
61 :     all become C<Y>. C<0>, C<n>, C<f>, and C<false> all become C<N>. Anything
62 :     else (including an undefined value) becomes a question mark. The process is
63 :     entirely case-insensitive.
64 :    
65 :     =over 4
66 :    
67 :     =item string
68 :    
69 :     String to convert to a ternary value.
70 :    
71 :     =item RETURN
72 :    
73 :     A single-character ternary value computed from a string.
74 :    
75 :     =back
76 :    
77 :     =cut
78 :    
79 :     sub ComputeFromString {
80 :     # Get the parameters.
81 :     my ($string) = @_;
82 :     # Default the return value to "?".
83 :     my $retVal = "?";
84 :     # Insure the string is defined.
85 :     if (defined $string) {
86 :     # Convert it to lower case.
87 :     my $lowerString = lc $string;
88 :     # Look for yes-like stuff.
89 :     if ($lowerString =~ /^(y|yes|t|true|1)$/) {
90 :     $retVal = 'Y';
91 :     } elsif ($lowerString =~ /^(n|no|false|0)$/) {
92 :     $retVal = 'N';
93 :     }
94 :     }
95 :     # Return the result.
96 :     return $retVal;
97 :     }
98 :    
99 :    
100 :     =head2 Virtual Methods
101 :    
102 :     =head3 averageLength
103 :    
104 :     my $value = $et->averageLength();
105 :    
106 :     Return the average length of a data item of this field type when it is stored in the
107 :     database. This value is used to compute the expected size of a database table.
108 :    
109 :     =cut
110 :    
111 :     sub averageLength {
112 :     return 80;
113 :     }
114 :    
115 :     =head3 prettySortValue
116 :    
117 :     my $value = $et->prettySortValue();
118 :    
119 :     Number indicating where fields of this type should go in relation to other
120 :     fields. The value should be somewhere between C<1> and C<5>. A value outside
121 :     that range will make terrible things happen.
122 :    
123 :     =cut
124 :    
125 :     sub prettySortValue() {
126 :     return 1;
127 :     }
128 :    
129 :     =head3 validate
130 :    
131 :     my $okFlag = $et->validate($value);
132 :    
133 :     Return an error message if the specified value is invalid for this field type.
134 :    
135 :     The parameters are as follows.
136 :    
137 :     =over 4
138 :    
139 :     =item value
140 :    
141 :     Value of this type, for validation.
142 :    
143 :     =item RETURN
144 :    
145 :     Returns an empty string if the specified field is valid, and an error message
146 :     otherwise.
147 :    
148 :     =back
149 :    
150 :     =cut
151 :    
152 :     sub validate {
153 :     # Get the parameters.
154 :     my ($self, $value) = @_;
155 :     # Assume it's valid until we prove otherwise.
156 :     my $retVal = "";
157 :     if (not $value =~ /^[YN\?]$/) {
158 :     $retVal = 'Illegal semi-boolean (ternary) value.';
159 :     }
160 :     # Return the determination.
161 :     return $retVal;
162 :     }
163 :    
164 :     =head3 encode
165 :    
166 :     my $string = $et->encode($value, $mode);
167 :    
168 :     Encode a value of this field type for storage in the database (or in a database load
169 :     file.)
170 :    
171 :     The parameters are as follows.
172 :    
173 :     =over 4
174 :    
175 :     =item value
176 :    
177 :     Value of this type, for encoding.
178 :    
179 :     =item mode
180 :    
181 :     TRUE if the value is being encoding for placement in a load file, FALSE if it
182 :     is being encoded for use as an SQL statement parameter. In most cases, the
183 :     encoding is the same for both modes.
184 :    
185 :     =back
186 :    
187 :     =cut
188 :    
189 :     sub encode {
190 :     # Get the parameters.
191 :     my ($self, $value, $mode) = @_;
192 :     # Return the result.
193 :     return $value;
194 :     }
195 :    
196 :     =head3 decode
197 :    
198 :     my $value = $et->decode($string);
199 :    
200 :     Decode a string from the database into a value of this field type.
201 :    
202 :     The parameters are as follows.
203 :    
204 :     =over 4
205 :    
206 :     =item string
207 :    
208 :     String from the database to be decoded.
209 :    
210 :     =item RETURN
211 :    
212 :     Returns a value of the desired type.
213 :    
214 :     =back
215 :    
216 :     =cut
217 :    
218 :     sub decode {
219 :     # Get the parameters.
220 :     my ($self, $string) = @_;
221 :     # Return the result.
222 :     return $string;
223 :     }
224 :    
225 :     =head3 sqlType
226 :    
227 : parrello 1.3 my $typeString = $et->sqlType($dbh);
228 : parrello 1.1
229 :     Return the SQL data type for this field type.
230 :    
231 : parrello 1.3 =over 4
232 :    
233 :     =item dbh
234 :    
235 :     Open L<DBKernel> handle for the database in question. This is used when the
236 :     datatype may be different depending on the DBMS used.
237 :    
238 :     =item RETURN
239 :    
240 :     Returns the datatype string to be used when creating a field of this type in
241 :     an SQL table.
242 :    
243 :     =back
244 :    
245 : parrello 1.1 =cut
246 :    
247 :     sub sqlType {
248 :     return "CHAR(1)";
249 :     }
250 :    
251 :     =head3 indexMod
252 :    
253 :     my $length = $et->indexMod();
254 :    
255 :     Return the index modifier for this field type. The index modifier is the number of
256 :     characters to be indexed. If it is undefined, the field cannot be indexed. If it
257 :     is an empty string, the entire field is indexed. The default is an empty string.
258 :    
259 :     =cut
260 :    
261 :     sub indexMod {
262 :     return '';
263 :     }
264 :    
265 :     =head3 sortType
266 :    
267 :     my $letter = $et->sortType();
268 :    
269 :     Return the sorting type for this field type. The sorting type is C<n> for integers,
270 :     C<g> for floating-point numbers, and the empty string for character fields.
271 :     The default is the empty string.
272 :    
273 :     =cut
274 :    
275 :     sub sortType {
276 :     return "";
277 :     }
278 :    
279 :     =head3 documentation
280 :    
281 :     my $docText = $et->documentation();
282 :    
283 :     Return the documentation text for this field type. This should be in TWiki markup
284 :     format, though HTML will also work.
285 :    
286 :     =cut
287 :    
288 :     sub documentation() {
289 :     return 'Ternary boolean value-- Y, N, or ?.';
290 :     }
291 :    
292 :     =head3 name
293 :    
294 :     my $name = $et->name();
295 :    
296 :     Return the name of this type, as it will appear in the XML database definition.
297 :    
298 :     =cut
299 :    
300 :     sub name() {
301 :     return "semi-boolean";
302 :     }
303 :    
304 :     =head3 default
305 :    
306 :     my $defaultValue = $et->default();
307 :    
308 :     Return the default value to be used for fields of this type if no default value
309 : parrello 1.2 is specified in the database definition or in an L<ERDBLoadGroup/Put> call
310 : parrello 1.1 during a loader operation. The default is undefined, which means an error will
311 :     be thrown during the load.
312 :    
313 :     =cut
314 :    
315 :     sub default {
316 :     return '?';
317 :     }
318 :    
319 :     =head3 align
320 :    
321 :     my $alignment = $et->align();
322 :    
323 :     Return the display alignment for fields of this type: either C<left>, C<right>, or
324 :     C<center>. The default is C<left>.
325 :    
326 :     =cut
327 :    
328 :     sub align {
329 :     return 'center';
330 :     }
331 :    
332 :     =head3 html
333 :    
334 :     my $html = $et->html($value);
335 :    
336 :     Return the HTML for displaying the content of a field of this type in an output
337 :     table. The default is the raw value, html-escaped.
338 :    
339 :     =cut
340 :    
341 :     sub html {
342 :     my ($self, $value) = @_;
343 :     my $retVal = "";
344 :     if ($value eq 'Y') {
345 :     $retVal = "Yes";
346 :     } elsif ($value eq 'N') {
347 :     $retVal = "No";
348 :     }
349 :     return $retVal;
350 :     }
351 :    
352 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3