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

Annotation of /Sprout/ERDBTypeLink.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3