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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3