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

Annotation of /FigKernelPackages/FIGMODELTable.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (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 : chenry 1.3 my ($self,$Key,$HashColumn,$AddRow) = @_;
192 : chenry 1.1 if (defined($self->{"hash columns"}->{$HashColumn}->{$Key}->[0])) {
193 :     return $self->{"hash columns"}->{$HashColumn}->{$Key}->[0];
194 : chenry 1.3 } elsif (defined($AddRow) && $AddRow == 1) {
195 :     my $NewRow = {$HashColumn => [$Key]};
196 :     $self->add_row($NewRow);
197 :     return $NewRow;
198 : chenry 1.1 }
199 :     return undef;
200 :     }
201 :    
202 :     =head3 get_rows_by_key
203 :     Definition:
204 :     my @RowObjects = $TableObj->get_rows_by_key($Key);
205 :     Description:
206 :     Returns the list of row objects that match the input key. Returns an empty list if nothing matches the input key.
207 :     Example:
208 :     my @RowObjects = $TableObj->get_rows_by_key("rxn00001");
209 :     =cut
210 :    
211 :     sub get_rows_by_key {
212 :     my ($self,$Key,$HashColumn) = @_;
213 :     if (defined($self->{"hash columns"}->{$HashColumn}->{$Key})) {
214 :     return @{$self->{"hash columns"}->{$HashColumn}->{$Key}};
215 :     }
216 :     return ();
217 :     }
218 :    
219 :     =head3 get_hash_column_keys
220 :     Definition:
221 :     my @HashKeys = $TableObj->get_hash_column_keys($HashColumn);
222 :     Description:
223 :     Returns the list of the keys stored in the hash of the values in the column labeled $HashColumn.
224 :     Example:
225 :     my @HashKeys = $TableObj->get_hash_column_keys("Media");
226 :     =cut
227 :    
228 :     sub get_hash_column_keys {
229 :     my ($self,$HashColumn) = @_;
230 :     if (defined($self->{"hash columns"}->{$HashColumn})) {
231 :     return keys(%{$self->{"hash columns"}->{$HashColumn}});
232 :     }
233 :     return ();
234 :     }
235 :    
236 :     =head3 add_row
237 :     Definition:
238 :     $TableObj->add_row($row_object);
239 :     Description:
240 :     Adds a row to the table.
241 :     Example:
242 :     $TableObj->add_row({"COLUMN 1" => ["A"],"COLUMN 2" => ["B"]});
243 :     =cut
244 :    
245 :     sub add_row {
246 : chenry 1.3 my ($self,$RowObject,$RowIndex) = @_;
247 :     if (defined($RowIndex) && $RowIndex == 0) {
248 :     unshift(@{$self->{"array"}},$RowObject);
249 :     } else {
250 :     push(@{$self->{"array"}},$RowObject);
251 :     }
252 : chenry 1.1 my @HashHeadings = $self->hash_headings();
253 :     foreach my $HashHeading (@HashHeadings) {
254 :     if (defined($RowObject->{$HashHeading})) {
255 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
256 :     push(@{$self->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
257 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
258 :     }
259 :     }
260 :     }
261 :     return ();
262 :     }
263 :    
264 : chenry 1.3 =head3 sort_rows
265 :     Definition:
266 :     $TableObj->sort_rows($sortcolumn);
267 :     Description:
268 :     Sorts the rows in the table by the specified column
269 :     Example:
270 :     =cut
271 :    
272 :     sub sort_rows {
273 :     my ($self,$sortcolumn) = @_;
274 :    
275 :     @{$self->{"array"}} = sort { $a->{$sortcolumn}->[0] <=> $b->{$sortcolumn}->[0] } @{$self->{"array"}};
276 :     }
277 :    
278 :     =head3 replace_row
279 :     Definition:
280 :     $TableObj->replace_row($OriginalRow,$NewRow);
281 :     Description:
282 :     Replaces the original row in the table with the new row.
283 :     Example:
284 :     =cut
285 :    
286 :     sub replace_row {
287 :     my ($self,$OriginalRow,$NewRow) = @_;
288 :    
289 :     for (my $i=0; $i < $self->size(); $i++) {
290 :     if ($self->get_row($i) == $OriginalRow) {
291 :     $self->{"array"}->[$i] = $NewRow;
292 :     last;
293 :     }
294 :     }
295 :     }
296 :    
297 : chenry 1.1 =head3 add_data
298 :     Definition:
299 :     $TableObj->add_data($Row,"TEST",1,1);
300 :     Description:
301 :     Deletes a row from the table.
302 :     Example:
303 :     $TableObj->delete_row(1);
304 :     =cut
305 :    
306 :     sub add_data {
307 :     my ($self,$RowObject,$Heading,$Data,$Unique) = @_;
308 :    
309 :     #First checking that the input row exists
310 :     if (!defined($RowObject)) {
311 :     return 0;
312 :     }
313 :    
314 :     #Now checking if the heading exists in the row
315 :     if (defined($Unique) && $Unique == 1 && defined($RowObject->{$Heading})) {
316 :     for (my $i=0; $i < @{$RowObject->{$Heading}}; $i++) {
317 :     if ($RowObject->{$Heading}->[$i] eq $Data) {
318 :     return 0;
319 :     }
320 :     }
321 :     }
322 :    
323 :     #Adding the data
324 :     push(@{$RowObject->{$Heading}},$Data);
325 :     my @HashHeadings = $self->hash_headings();
326 :     foreach my $HashHeading (@HashHeadings) {
327 :     if ($HashHeading eq $Heading) {
328 :     push(@{$self->{$Data}},$RowObject);
329 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$Data}},$RowObject);
330 :     last;
331 :     }
332 :     }
333 :     return 1;
334 :     }
335 :    
336 : chenry 1.2 =head3 remove_data
337 :     Definition:
338 :     $TableObj->remove_data($Row,"HEADING","TEST");
339 :     Description:
340 :     Deletes a element of data from the input row
341 :     Example:
342 :     $TableObj->remove_data(1);
343 :     =cut
344 :    
345 :     sub remove_data {
346 :     my ($self,$RowObject,$Heading,$Data) = @_;
347 :    
348 :     #First checking that the input row exists
349 :     if (!defined($RowObject)) {
350 :     return 0;
351 :     }
352 :    
353 :     #Now checking if the heading exists in the row
354 :     if (defined($RowObject->{$Heading})) {
355 :     for (my $i=0; $i < @{$RowObject->{$Heading}}; $i++) {
356 :     if ($RowObject->{$Heading}->[$i] eq $Data) {
357 :     splice(@{$RowObject->{$Heading}},$i,1);
358 :     $i--;
359 :     }
360 :     }
361 :     if (defined($self->{"hash columns"}->{$Heading}) && defined($self->{"hash columns"}->{$Heading}->{$Data})) {
362 :     if (@{$self->{"hash columns"}->{$Heading}->{$Data}} == 1) {
363 :     delete $self->{"hash columns"}->{$Heading}->{$Data};
364 :     } else {
365 :     for (my $j=0; $j < @{$self->{"hash columns"}->{$Heading}->{$Data}}; $j++) {
366 :     if ($self->{"hash columns"}->{$Heading}->{$Data}->[$j] eq $RowObject) {
367 :     splice(@{$self->{"hash columns"}->{$Heading}->{$Data}},$j,1);
368 :     $j--;
369 :     }
370 :     }
371 :     }
372 :     }
373 :     }
374 :    
375 :     return 1;
376 :     }
377 :    
378 : chenry 1.1 =head3 row_index
379 :     Definition:
380 :     $TableObj->row_index($Row);
381 :     Description:
382 :     Returns the index in the table where the input row is stored.
383 :     This only works if the input $Row object was pulled from the table using one of the get_row functions.
384 :     Returns undef if the row could not be found.
385 :     Example:
386 :     $TableObj->row_index($Row);
387 :     =cut
388 :    
389 :     sub row_index {
390 :     my ($self,$Row) = @_;
391 :    
392 :     for (my $i=0; $i < $self->size(); $i++) {
393 :     if ($self->get_row($i) == $Row) {
394 :     return $i;
395 :     }
396 :     }
397 :    
398 :     return undef;
399 :     }
400 :    
401 :     =head3 delete_row_by_key
402 :     Definition:
403 :     $TableObj->delete_row_by_key($Key,$Heading);
404 :     Description:
405 :     Deletes a row from the table based on the input key and heading that the key will be stored under.
406 :     Returns 1 if a row was found and deleted. Returns 0 if no row was found.
407 :     Example:
408 :     $TableObj->delete_row_by_key("Core83333.1","Model ID");
409 :     =cut
410 :    
411 :     sub delete_row_by_key {
412 :     my ($self,$Key,$Heading) = @_;
413 :    
414 :     my $Row = $self->get_row_by_key($Key,$Heading);
415 :     if (defined($Row)) {
416 :     $self->delete_row($self->row_index($Row));
417 :     return 1;
418 :     }
419 :     return 0;
420 :     }
421 :    
422 :     =head3 delete_row
423 :     Definition:
424 :     $TableObj->delete_row($i);
425 :     Description:
426 :     Deletes a row from the table.
427 :     Example:
428 :     $TableObj->delete_row(1);
429 :     =cut
430 :    
431 :     sub delete_row {
432 :     my ($self,$RowIndex) = @_;
433 :     my @HashHeadings = $self->hash_headings();
434 :     foreach my $HashHeading (@HashHeadings) {
435 :     my $RowObject = $self->get_row($RowIndex);
436 :     if (defined($RowObject->{$HashHeading})) {
437 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
438 :     if (defined($self->{$RowObject->{$HashHeading}->[$i]})) {
439 :     for (my $j =0; $j < @{$self->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
440 :     if ($self->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
441 :     if ($j == 0 && @{$self->{$RowObject->{$HashHeading}->[$i]}} == 1) {
442 :     delete $self->{$RowObject->{$HashHeading}->[$i]};
443 :     last;
444 :     } else {
445 :     splice(@{$self->{$RowObject->{$HashHeading}->[$i]}},$j,1);
446 :     $j--;
447 :     }
448 :     }
449 :     }
450 :     }
451 :     if (defined($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]})) {
452 :     for (my $j =0; $j < @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
453 :     if ($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
454 :     if ($j == 0 && @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}} == 1) {
455 :     delete $self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]};
456 :     last;
457 :     } else {
458 :     splice(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$j,1);
459 :     $j--;
460 :     }
461 :     }
462 :     }
463 :     }
464 :     }
465 :     }
466 :     }
467 :     splice(@{$self->{"array"}},$RowIndex,1);
468 :     }
469 :    
470 :     =head3 add_headings
471 :     Definition:
472 :     $TableObj->add_headings(@Headings);
473 :     Description:
474 :     Adds new headings to the table. This is needed to get the table to print the data under the new heading.
475 :     Example:
476 :     $TableObj->add_headings("Notes");
477 :     =cut
478 :    
479 :     sub add_headings {
480 :     my ($self,@Headings) = @_;
481 :    
482 :     foreach my $Heading (@Headings) {
483 :     #First check if the heading already exists
484 :     foreach my $ExistingHeading ($self->headings()) {
485 :     if ($Heading eq $ExistingHeading) {
486 :     $Heading = "";
487 :     last;
488 :     }
489 :     }
490 :     if ($Heading ne "") {
491 :     push(@{$self->{"file IO settings"}->{"orderedkeys"}},$Heading);
492 :     }
493 :     }
494 :     }
495 :    
496 :     =head3 save
497 :     Definition:
498 :     $TableObj->save($filename,$delimiter,$itemdelimiter,$prefix);
499 :     Description:
500 :     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).
501 :     All arguments are optional. If arguments are not supplied, the values used to read the table from file will be used.
502 :     Example:
503 :     $TableObj->save("/vol/Table.txt",";","|","REACTIONS");
504 :     =cut
505 :    
506 :     sub save {
507 :     my ($self,$filename,$delimiter,$itemdelimiter,$prefix) = @_;
508 :     if (defined($filename)) {
509 :     $self->{"file IO settings"}->{"filename"}->[0] = $filename;
510 :     }
511 :     if (defined($delimiter)) {
512 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $delimiter;
513 :     }
514 :     if (defined($itemdelimiter)) {
515 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $itemdelimiter;
516 :     }
517 :     if (defined($prefix)) {
518 :     $self->{"file IO settings"}->{"file prefix"}->[0] = $prefix;
519 :     }
520 :     FIGMODEL::SaveTable($self);
521 :     }
522 :    
523 :     =head3 load
524 :     Definition:
525 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
526 :     Description:
527 :    
528 :     Example:
529 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
530 :     =cut
531 :    
532 :     sub load_table {
533 :     my ($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns) = @_;
534 :    
535 :     #Checking that the table file exists
536 :     if (!-e $Filename) {
537 :     return undef;
538 :     }
539 :    
540 :     #Sanity checking input values
541 :     if (!defined($HeadingLine) || $HeadingLine eq "") {
542 :     $HeadingLine = 0;
543 :     }
544 :     if (!defined($Delimiter) || $Delimiter eq "") {
545 :     $Delimiter = ";";
546 :     }
547 :     if ($Delimiter eq "|") {
548 :     $Delimiter = "\\|";
549 :     }
550 :     if (!defined($ItemDelimiter) || $ItemDelimiter eq "") {
551 :     $ItemDelimiter = "";
552 :     } elsif ($ItemDelimiter eq "|") {
553 :     $ItemDelimiter = "\\|";
554 :     }
555 :    
556 :     #Loading the data table
557 :     my $Prefix;
558 :     my @Headings;
559 :     if (!open (TABLEINPUT, "<$Filename")) {
560 :     return undef;
561 :     }
562 :     my $Line = <TABLEINPUT>;
563 :     for (my $i=0; $i < $HeadingLine; $i++) {
564 :     $Prefix .= $Line;
565 :     $Line = <TABLEINPUT>;
566 :     }
567 :     chomp($Line);
568 :     @Headings = split(/$Delimiter/,$Line);
569 :     my $HeadingRef;
570 :     push(@{$HeadingRef},@Headings);
571 :     my $Table = new FIGMODELTable($HeadingRef,$Filename,$HashColumns,$Delimiter,$ItemDelimiter,$Prefix);
572 :    
573 :     while ($Line = <TABLEINPUT>) {
574 :     chomp($Line);
575 :     my @Data = split(/$Delimiter/,$Line);
576 :     my $ArrayRefHashRef;
577 :     for (my $i=0; $i < @Headings; $i++) {
578 :     if (defined($Data[$i]) && length($Data[$i]) > 0) {
579 :     if (defined($ItemDelimiter) && length($ItemDelimiter) > 0) {
580 :     my @TempArray = split(/$ItemDelimiter/,$Data[$i]);
581 :     foreach my $Item (@TempArray) {
582 :     push(@{$ArrayRefHashRef->{$Headings[$i]}},$Item);
583 :     }
584 :     } else {
585 :     $ArrayRefHashRef->{$Headings[$i]}->[0] = $Data[$i];
586 :     }
587 :     }
588 :     }
589 :     $Table->add_row($ArrayRefHashRef);
590 :     }
591 :     close(TABLEINPUT);
592 :    
593 :     return $Table;
594 :     }
595 :    
596 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3