[Bio] / FigKernelPackages / FIGMODELTable.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/FIGMODELTable.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (view) (download) (as text)

1 : chenry 1.1 # -*- perl -*-
2 :     ########################################################################
3 :     #
4 :     # Table object for the model database interaction module
5 :     # Initiating author: Christopher Henry
6 :     # Initiating author email: chrisshenry@gmail.com
7 :     # Initiating author affiliation: Mathematics and Computer Science Division, Argonne National Lab
8 :     # Date of module creation: 2/1/2008
9 :     ########################################################################
10 :    
11 :     use strict;
12 :     use FIGMODEL;
13 :    
14 :     package FIGMODELTable;
15 :    
16 :     =head1 Table object for the model database interaction module
17 :    
18 :     =head2 Public Methods
19 :    
20 :     =head3 new
21 :     Definition:
22 :     my $TableObj = FIGMODELTable->new($heading_list_ref,$filename,$hash_heading_list_ref,$delimiter,$itemdelimiter,$prefix);
23 :     Description:
24 :     Creates an empty table object which may be filled using the add row function.
25 :     The $heading_list_ref and $filename are required, but all remaining arguments are optional.
26 :     Example:
27 :     my $TableObj = FIGMODELTable->new($heading_list_ref,$filename,$hash_heading_list_ref,$delimiter,$itemdelimiter,$prefix);
28 :     =cut
29 :    
30 :     sub new {
31 :     my ($ObjectType,$headings,$filename,$hash_headings,$delimiter,$itemdelimiter,$prefix) = @_;
32 :    
33 :     my $self;
34 :     if (!defined($filename) || !defined($headings)) {
35 :     print STDERR "FIGMODELTable:new: cannot create table without a list of headings and a filename\n";
36 :     return undef;
37 :     }
38 :     $self->{"file IO settings"}->{"filename"}->[0] = $filename;
39 :     $self->{"file IO settings"}->{"orderedkeys"} = $headings;
40 :     #Dealing with optional arguments
41 :     if (defined($hash_headings)) {
42 :     for (my $i=0; $i < @{$hash_headings}; $i++) {
43 :     $self->{"hash columns"}->{$hash_headings->[$i]} = {};
44 :     }
45 :     }
46 :     if (!defined($delimiter)) {
47 :     $delimiter = ";";
48 :     }
49 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $delimiter;
50 :     if (!defined($itemdelimiter)) {
51 :     $itemdelimiter = "|";
52 :     }
53 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $itemdelimiter;
54 :     if (!defined($prefix)) {
55 :     $prefix = "";
56 :     }
57 :     $self->{"file IO settings"}->{"file prefix"}->[0] = $prefix;
58 :    
59 :     return bless $self;
60 :     }
61 :    
62 :     =head2 TABLE Methods
63 :    
64 :     =head3 size
65 :     Definition:
66 :     my $tablesize = $TableObj->size();
67 :     Description:
68 :     This returns the number of rows in the table
69 :     Example:
70 :     my $tablesize = $TableObj->size();
71 :     =cut
72 :    
73 :     sub size {
74 :     my ($self) = @_;
75 :     my $TableSize = 0;
76 :     if (defined($self->{"array"})) {
77 :     $TableSize = @{$self->{"array"}};
78 :     }
79 :     return $TableSize;
80 :     }
81 :    
82 :     =head3 get_row
83 :     Definition:
84 :     my $RowObject = $TableObj->get_row($Row_index);
85 :     Description:
86 :     Returns a hash reference for the specified row in the table. Returns undef if the row does not exist.
87 :     Example:
88 :     my $RowObject = $TableObj->get_row(1);
89 :     =cut
90 :    
91 :     sub get_row {
92 :     my ($self,$RowNumber) = @_;
93 :     return $self->{"array"}->[$RowNumber];
94 :     }
95 :    
96 :     =head3 filename
97 :     Definition:
98 :     my $filename = $TableObj->filename();
99 :     Description:
100 :     Returns the filename for the table.
101 :     Example:
102 :     my $filename = $TableObj->filename();
103 :     =cut
104 :    
105 :     sub filename {
106 :     my ($self,$NewFilename) = @_;
107 :    
108 :     if (defined($NewFilename)) {
109 :     $self->{"file IO settings"}->{"filename"}->[0] = $NewFilename;
110 :     }
111 :    
112 :     return $self->{"file IO settings"}->{"filename"}->[0];
113 :     }
114 :    
115 :     =head3 delimiter
116 :     Definition:
117 :     my $delimiter = $TableObj->delimiter();
118 :     Description:
119 :     Returns the delimiter for the table.
120 :     Example:
121 :     my $delimiter = $TableObj->delimiter();
122 :     =cut
123 :    
124 :     sub delimiter {
125 :     my ($self,$NewDelimiter) = @_;
126 :    
127 :     if (defined($NewDelimiter)) {
128 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $NewDelimiter;
129 :     }
130 :    
131 :     return $self->{"file IO settings"}->{"delimiter"}->[0];
132 :     }
133 :    
134 :     =head3 item_delimiter
135 :     Definition:
136 :     my $item_delimiter = $TableObj->item_delimiter();
137 :     Description:
138 :     Returns the item delimiter for the table.
139 :     Example:
140 :     my $item_delimiter = $TableObj->item_delimiter();
141 :     =cut
142 :    
143 :     sub item_delimiter {
144 :     my ($self,$ItemDelimiter) = @_;
145 :    
146 :     if (defined($ItemDelimiter)) {
147 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $ItemDelimiter;
148 :     }
149 :    
150 :     return $self->{"file IO settings"}->{"item delimiter"}->[0];
151 :     }
152 :    
153 :     =head3 headings
154 :     Definition:
155 :     my @Headings = $TableObj->headings();
156 :     Description:
157 :     Returns an array containing the headings for the table.
158 :     Example:
159 :     my @Headings = $TableObj->headings();
160 :     =cut
161 :    
162 :     sub headings {
163 :     my ($self) = @_;
164 :     return @{$self->{"file IO settings"}->{"orderedkeys"}};
165 :     }
166 :    
167 :     =head3 get_table_hash_headings
168 :     Definition:
169 :     my @hash_headings = $TableObj->get_table_hash_headings();
170 :     Description:
171 :     Returns an array containing the headings that have also been added to the hash key for the table.
172 :     Example:
173 :     my @hash_headings = $TableObj->get_table_hash_headings();
174 :     =cut
175 :    
176 :     sub hash_headings {
177 :     my ($self) = @_;
178 :     return keys(%{$self->{"hash columns"}});
179 :     }
180 :    
181 :     =head3 get_row_by_key
182 :     Definition:
183 :     my $RowObject = $TableObj->get_row_by_key($Key);
184 :     Description:
185 :     Returns the row object for the firt row that matches the input key. Return undef if nothing matches the input key.
186 :     Example:
187 :     my $RowObject = $TableObj->get_row_by_key("rxn00001");
188 :     =cut
189 :    
190 :     sub get_row_by_key {
191 :     my ($self,$Key,$HashColumn) = @_;
192 :     if (defined($self->{"hash columns"}->{$HashColumn}->{$Key}->[0])) {
193 :     return $self->{"hash columns"}->{$HashColumn}->{$Key}->[0];
194 :     }
195 :     return undef;
196 :     }
197 :    
198 :     =head3 get_rows_by_key
199 :     Definition:
200 :     my @RowObjects = $TableObj->get_rows_by_key($Key);
201 :     Description:
202 :     Returns the list of row objects that match the input key. Returns an empty list if nothing matches the input key.
203 :     Example:
204 :     my @RowObjects = $TableObj->get_rows_by_key("rxn00001");
205 :     =cut
206 :    
207 :     sub get_rows_by_key {
208 :     my ($self,$Key,$HashColumn) = @_;
209 :     if (defined($self->{"hash columns"}->{$HashColumn}->{$Key})) {
210 :     return @{$self->{"hash columns"}->{$HashColumn}->{$Key}};
211 :     }
212 :     return ();
213 :     }
214 :    
215 :     =head3 get_hash_column_keys
216 :     Definition:
217 :     my @HashKeys = $TableObj->get_hash_column_keys($HashColumn);
218 :     Description:
219 :     Returns the list of the keys stored in the hash of the values in the column labeled $HashColumn.
220 :     Example:
221 :     my @HashKeys = $TableObj->get_hash_column_keys("Media");
222 :     =cut
223 :    
224 :     sub get_hash_column_keys {
225 :     my ($self,$HashColumn) = @_;
226 :     if (defined($self->{"hash columns"}->{$HashColumn})) {
227 :     return keys(%{$self->{"hash columns"}->{$HashColumn}});
228 :     }
229 :     return ();
230 :     }
231 :    
232 :     =head3 add_row
233 :     Definition:
234 :     $TableObj->add_row($row_object);
235 :     Description:
236 :     Adds a row to the table.
237 :     Example:
238 :     $TableObj->add_row({"COLUMN 1" => ["A"],"COLUMN 2" => ["B"]});
239 :     =cut
240 :    
241 :     sub add_row {
242 :     my ($self,$RowObject) = @_;
243 :     push(@{$self->{"array"}},$RowObject);
244 :     my @HashHeadings = $self->hash_headings();
245 :     foreach my $HashHeading (@HashHeadings) {
246 :     if (defined($RowObject->{$HashHeading})) {
247 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
248 :     push(@{$self->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
249 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
250 :     }
251 :     }
252 :     }
253 :     return ();
254 :     }
255 :    
256 :     =head3 add_data
257 :     Definition:
258 :     $TableObj->add_data($Row,"TEST",1,1);
259 :     Description:
260 :     Deletes a row from the table.
261 :     Example:
262 :     $TableObj->delete_row(1);
263 :     =cut
264 :    
265 :     sub add_data {
266 :     my ($self,$RowObject,$Heading,$Data,$Unique) = @_;
267 :    
268 :     #First checking that the input row exists
269 :     if (!defined($RowObject)) {
270 :     return 0;
271 :     }
272 :    
273 :     #Now checking if the heading exists in the row
274 :     if (defined($Unique) && $Unique == 1 && defined($RowObject->{$Heading})) {
275 :     for (my $i=0; $i < @{$RowObject->{$Heading}}; $i++) {
276 :     if ($RowObject->{$Heading}->[$i] eq $Data) {
277 :     return 0;
278 :     }
279 :     }
280 :     }
281 :    
282 :     #Adding the data
283 :     push(@{$RowObject->{$Heading}},$Data);
284 :     my @HashHeadings = $self->hash_headings();
285 :     foreach my $HashHeading (@HashHeadings) {
286 :     if ($HashHeading eq $Heading) {
287 :     push(@{$self->{$Data}},$RowObject);
288 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$Data}},$RowObject);
289 :     last;
290 :     }
291 :     }
292 :     return 1;
293 :     }
294 :    
295 :     =head3 row_index
296 :     Definition:
297 :     $TableObj->row_index($Row);
298 :     Description:
299 :     Returns the index in the table where the input row is stored.
300 :     This only works if the input $Row object was pulled from the table using one of the get_row functions.
301 :     Returns undef if the row could not be found.
302 :     Example:
303 :     $TableObj->row_index($Row);
304 :     =cut
305 :    
306 :     sub row_index {
307 :     my ($self,$Row) = @_;
308 :    
309 :     for (my $i=0; $i < $self->size(); $i++) {
310 :     if ($self->get_row($i) == $Row) {
311 :     return $i;
312 :     }
313 :     }
314 :    
315 :     return undef;
316 :     }
317 :    
318 :     =head3 delete_row_by_key
319 :     Definition:
320 :     $TableObj->delete_row_by_key($Key,$Heading);
321 :     Description:
322 :     Deletes a row from the table based on the input key and heading that the key will be stored under.
323 :     Returns 1 if a row was found and deleted. Returns 0 if no row was found.
324 :     Example:
325 :     $TableObj->delete_row_by_key("Core83333.1","Model ID");
326 :     =cut
327 :    
328 :     sub delete_row_by_key {
329 :     my ($self,$Key,$Heading) = @_;
330 :    
331 :     my $Row = $self->get_row_by_key($Key,$Heading);
332 :     if (defined($Row)) {
333 :     $self->delete_row($self->row_index($Row));
334 :     return 1;
335 :     }
336 :     return 0;
337 :     }
338 :    
339 :     =head3 delete_row
340 :     Definition:
341 :     $TableObj->delete_row($i);
342 :     Description:
343 :     Deletes a row from the table.
344 :     Example:
345 :     $TableObj->delete_row(1);
346 :     =cut
347 :    
348 :     sub delete_row {
349 :     my ($self,$RowIndex) = @_;
350 :     my @HashHeadings = $self->hash_headings();
351 :     foreach my $HashHeading (@HashHeadings) {
352 :     my $RowObject = $self->get_row($RowIndex);
353 :     if (defined($RowObject->{$HashHeading})) {
354 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
355 :     if (defined($self->{$RowObject->{$HashHeading}->[$i]})) {
356 :     for (my $j =0; $j < @{$self->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
357 :     if ($self->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
358 :     if ($j == 0 && @{$self->{$RowObject->{$HashHeading}->[$i]}} == 1) {
359 :     delete $self->{$RowObject->{$HashHeading}->[$i]};
360 :     last;
361 :     } else {
362 :     splice(@{$self->{$RowObject->{$HashHeading}->[$i]}},$j,1);
363 :     $j--;
364 :     }
365 :     }
366 :     }
367 :     }
368 :     if (defined($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]})) {
369 :     for (my $j =0; $j < @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
370 :     if ($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
371 :     if ($j == 0 && @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}} == 1) {
372 :     delete $self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]};
373 :     last;
374 :     } else {
375 :     splice(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$j,1);
376 :     $j--;
377 :     }
378 :     }
379 :     }
380 :     }
381 :     }
382 :     }
383 :     }
384 :     splice(@{$self->{"array"}},$RowIndex,1);
385 :     }
386 :    
387 :     =head3 add_headings
388 :     Definition:
389 :     $TableObj->add_headings(@Headings);
390 :     Description:
391 :     Adds new headings to the table. This is needed to get the table to print the data under the new heading.
392 :     Example:
393 :     $TableObj->add_headings("Notes");
394 :     =cut
395 :    
396 :     sub add_headings {
397 :     my ($self,@Headings) = @_;
398 :    
399 :     foreach my $Heading (@Headings) {
400 :     #First check if the heading already exists
401 :     foreach my $ExistingHeading ($self->headings()) {
402 :     if ($Heading eq $ExistingHeading) {
403 :     $Heading = "";
404 :     last;
405 :     }
406 :     }
407 :     if ($Heading ne "") {
408 :     push(@{$self->{"file IO settings"}->{"orderedkeys"}},$Heading);
409 :     }
410 :     }
411 :     }
412 :    
413 :     =head3 save
414 :     Definition:
415 :     $TableObj->save($filename,$delimiter,$itemdelimiter,$prefix);
416 :     Description:
417 :     Saves the table to the specified filename with the specified column delimiter and subcolumn delimiter, and file prefix (lines that appear before the table heading in the file).
418 :     All arguments are optional. If arguments are not supplied, the values used to read the table from file will be used.
419 :     Example:
420 :     $TableObj->save("/vol/Table.txt",";","|","REACTIONS");
421 :     =cut
422 :    
423 :     sub save {
424 :     my ($self,$filename,$delimiter,$itemdelimiter,$prefix) = @_;
425 :     if (defined($filename)) {
426 :     $self->{"file IO settings"}->{"filename"}->[0] = $filename;
427 :     }
428 :     if (defined($delimiter)) {
429 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $delimiter;
430 :     }
431 :     if (defined($itemdelimiter)) {
432 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $itemdelimiter;
433 :     }
434 :     if (defined($prefix)) {
435 :     $self->{"file IO settings"}->{"file prefix"}->[0] = $prefix;
436 :     }
437 :     FIGMODEL::SaveTable($self);
438 :     }
439 :    
440 :     =head3 load
441 :     Definition:
442 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
443 :     Description:
444 :    
445 :     Example:
446 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
447 :     =cut
448 :    
449 :     sub load_table {
450 :     my ($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns) = @_;
451 :    
452 :     #Checking that the table file exists
453 :     if (!-e $Filename) {
454 :     return undef;
455 :     }
456 :    
457 :     #Sanity checking input values
458 :     if (!defined($HeadingLine) || $HeadingLine eq "") {
459 :     $HeadingLine = 0;
460 :     }
461 :     if (!defined($Delimiter) || $Delimiter eq "") {
462 :     $Delimiter = ";";
463 :     }
464 :     if ($Delimiter eq "|") {
465 :     $Delimiter = "\\|";
466 :     }
467 :     if (!defined($ItemDelimiter) || $ItemDelimiter eq "") {
468 :     $ItemDelimiter = "";
469 :     } elsif ($ItemDelimiter eq "|") {
470 :     $ItemDelimiter = "\\|";
471 :     }
472 :    
473 :     #Loading the data table
474 :     my $Prefix;
475 :     my @Headings;
476 :     if (!open (TABLEINPUT, "<$Filename")) {
477 :     return undef;
478 :     }
479 :     my $Line = <TABLEINPUT>;
480 :     for (my $i=0; $i < $HeadingLine; $i++) {
481 :     $Prefix .= $Line;
482 :     $Line = <TABLEINPUT>;
483 :     }
484 :     chomp($Line);
485 :     @Headings = split(/$Delimiter/,$Line);
486 :     my $HeadingRef;
487 :     push(@{$HeadingRef},@Headings);
488 :     my $Table = new FIGMODELTable($HeadingRef,$Filename,$HashColumns,$Delimiter,$ItemDelimiter,$Prefix);
489 :    
490 :     while ($Line = <TABLEINPUT>) {
491 :     chomp($Line);
492 :     my @Data = split(/$Delimiter/,$Line);
493 :     my $ArrayRefHashRef;
494 :     for (my $i=0; $i < @Headings; $i++) {
495 :     if (defined($Data[$i]) && length($Data[$i]) > 0) {
496 :     if (defined($ItemDelimiter) && length($ItemDelimiter) > 0) {
497 :     my @TempArray = split(/$ItemDelimiter/,$Data[$i]);
498 :     foreach my $Item (@TempArray) {
499 :     push(@{$ArrayRefHashRef->{$Headings[$i]}},$Item);
500 :     }
501 :     } else {
502 :     $ArrayRefHashRef->{$Headings[$i]}->[0] = $Data[$i];
503 :     }
504 :     }
505 :     }
506 :     $Table->add_row($ArrayRefHashRef);
507 :     }
508 :     close(TABLEINPUT);
509 :    
510 :     return $Table;
511 :     }
512 :    
513 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3