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

Annotation of /FigKernelPackages/FIGMODELTable.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : parrello 1.8 # -*- 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 :    
13 :     package FIGMODELTable;
14 :    
15 :     =head1 Table object for the model database interaction module
16 :    
17 :     =head2 Public Methods
18 :    
19 :     =head3 new
20 :     Definition:
21 :     my $TableObj = FIGMODELTable->new($heading_list_ref,$filename,$hash_heading_list_ref,$delimiter,$itemdelimiter,$prefix);
22 :     Description:
23 :     Creates an empty table object which may be filled using the add row function.
24 :     The $heading_list_ref and $filename are required, but all remaining arguments are optional.
25 :     Example:
26 :     my $TableObj = FIGMODELTable->new($heading_list_ref,$filename,$hash_heading_list_ref,$delimiter,$itemdelimiter,$prefix);
27 :     =cut
28 :    
29 :     sub new {
30 :     my ($ObjectType,$headings,$filename,$hash_headings,$delimiter,$itemdelimiter,$prefix) = @_;
31 :    
32 :     my $self;
33 :     if (!defined($filename) || !defined($headings)) {
34 :     print STDERR "FIGMODELTable:new: cannot create table without a list of headings and a filename\n";
35 :     return undef;
36 :     }
37 :     $self->{"file IO settings"}->{"filename"}->[0] = $filename;
38 :     $self->{"file IO settings"}->{"orderedkeys"} = $headings;
39 :     #Dealing with optional arguments
40 :     if (defined($hash_headings)) {
41 :     for (my $i=0; $i < @{$hash_headings}; $i++) {
42 :     $self->{"hash columns"}->{$hash_headings->[$i]} = {};
43 :     }
44 :     }
45 :     if (!defined($delimiter)) {
46 :     $delimiter = ";";
47 :     }
48 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $delimiter;
49 :     if (!defined($itemdelimiter)) {
50 :     $itemdelimiter = "|";
51 :     }
52 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $itemdelimiter;
53 :     if (!defined($prefix)) {
54 :     $prefix = "";
55 :     }
56 :     $self->{"file IO settings"}->{"file prefix"}->[0] = $prefix;
57 :    
58 :     return bless $self;
59 :     }
60 :    
61 :     =head2 TABLE Methods
62 :    
63 :     =head3 size
64 :     Definition:
65 :     my $tablesize = $TableObj->size();
66 :     Description:
67 :     This returns the number of rows in the table
68 :     Example:
69 :     my $tablesize = $TableObj->size();
70 :     =cut
71 :    
72 :     sub size {
73 :     my ($self) = @_;
74 :     my $TableSize = 0;
75 :     if (defined($self->{"array"})) {
76 :     $TableSize = @{$self->{"array"}};
77 :     }
78 :     return $TableSize;
79 :     }
80 :    
81 :     =head3 get_row
82 :     Definition:
83 :     my $RowObject = $TableObj->get_row($Row_index);
84 :     Description:
85 :     Returns a hash reference for the specified row in the table. Returns undef if the row does not exist.
86 :     Example:
87 :     my $RowObject = $TableObj->get_row(1);
88 :     =cut
89 :    
90 :     sub get_row {
91 :     my ($self,$RowNumber) = @_;
92 :     return $self->{"array"}->[$RowNumber];
93 :     }
94 :    
95 :     =head3 filename
96 :     Definition:
97 :     my $filename = $TableObj->filename();
98 :     Description:
99 :     Returns the filename for the table.
100 :     Example:
101 :     my $filename = $TableObj->filename();
102 :     =cut
103 :    
104 :     sub filename {
105 :     my ($self,$NewFilename) = @_;
106 :    
107 :     if (defined($NewFilename)) {
108 :     $self->{"file IO settings"}->{"filename"}->[0] = $NewFilename;
109 :     }
110 :    
111 :     return $self->{"file IO settings"}->{"filename"}->[0];
112 :     }
113 :    
114 :     =head3 delimiter
115 :     Definition:
116 :     my $delimiter = $TableObj->delimiter();
117 :     Description:
118 :     Returns the delimiter for the table.
119 :     Example:
120 :     my $delimiter = $TableObj->delimiter();
121 :     =cut
122 :    
123 :     sub delimiter {
124 :     my ($self,$NewDelimiter) = @_;
125 :    
126 :     if (defined($NewDelimiter)) {
127 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $NewDelimiter;
128 :     }
129 :    
130 :     return $self->{"file IO settings"}->{"delimiter"}->[0];
131 :     }
132 :    
133 :     =head3 item_delimiter
134 :     Definition:
135 :     my $item_delimiter = $TableObj->item_delimiter();
136 :     Description:
137 :     Returns the item delimiter for the table.
138 :     Example:
139 :     my $item_delimiter = $TableObj->item_delimiter();
140 :     =cut
141 :    
142 :     sub item_delimiter {
143 :     my ($self,$ItemDelimiter) = @_;
144 :    
145 :     if (defined($ItemDelimiter)) {
146 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $ItemDelimiter;
147 :     }
148 :    
149 :     return $self->{"file IO settings"}->{"item delimiter"}->[0];
150 :     }
151 :    
152 :     =head3 headings
153 :     Definition:
154 :     my @Headings = $TableObj->headings();
155 :     Description:
156 :     Returns an array containing the headings for the table.
157 :     Example:
158 :     my @Headings = $TableObj->headings();
159 :     =cut
160 :    
161 :     sub headings {
162 :     my ($self,$InHeadings) = @_;
163 :     if (defined($InHeadings)) {
164 :     $self->{"file IO settings"}->{"orderedkeys"} = $InHeadings;
165 :     }
166 :     return @{$self->{"file IO settings"}->{"orderedkeys"}};
167 :     }
168 :    
169 :     =head3 get_table_hash_headings
170 :     Definition:
171 :     my @hash_headings = $TableObj->get_table_hash_headings();
172 :     Description:
173 :     Returns an array containing the headings that have also been added to the hash key for the table.
174 :     Example:
175 :     my @hash_headings = $TableObj->get_table_hash_headings();
176 :     =cut
177 :    
178 :     sub hash_headings {
179 :     my ($self) = @_;
180 :     return keys(%{$self->{"hash columns"}});
181 :     }
182 :    
183 :     =head3 get_row_by_key
184 :     Definition:
185 :     my $RowObject = $TableObj->get_row_by_key($Key,$HashColumn,$AddRow);
186 :     Description:
187 :     Returns the row object for the firt row that matches the input key. Return undef if nothing matches the input key.
188 :     Example:
189 :     my $RowObject = $TableObj->get_row_by_key("rxn00001");
190 :     =cut
191 :    
192 :     sub get_row_by_key {
193 :     my ($self,$Key,$HashColumn,$AddRow) = @_;
194 :     if (defined($self->{"hash columns"}->{$HashColumn}->{$Key}->[0])) {
195 :     return $self->{"hash columns"}->{$HashColumn}->{$Key}->[0];
196 :     } elsif (defined($AddRow) && $AddRow == 1) {
197 :     my $NewRow = {$HashColumn => [$Key]};
198 :     $self->add_row($NewRow);
199 :     return $NewRow;
200 :     }
201 :     return undef;
202 :     }
203 :    
204 :     =head3 get_rows_by_key
205 :     Definition:
206 :     my @RowObjects = $TableObj->get_rows_by_key($Key);
207 :     Description:
208 :     Returns the list of row objects that match the input key. Returns an empty list if nothing matches the input key.
209 :     Example:
210 :     my @RowObjects = $TableObj->get_rows_by_key("rxn00001");
211 :     =cut
212 :    
213 :     sub get_rows_by_key {
214 :     my ($self,$Key,$HashColumn) = @_;
215 : chenry 1.12
216 : parrello 1.8 if (defined($self->{"hash columns"}->{$HashColumn}->{$Key})) {
217 :     return @{$self->{"hash columns"}->{$HashColumn}->{$Key}};
218 :     }
219 :     return ();
220 :     }
221 :    
222 :    
223 :     =head3 get_table_by_key
224 :     Definition:
225 :     my $NewTable = $TableObj->get_table_by_key();
226 :     Description:
227 :     Returns a new table object where every row matches the input key/data combo.
228 :     Returns an empty table if no rows match the input key/data combo.
229 :     Example:
230 :     my $NewTable = $TableObj->get_table_by_key();
231 :     =cut
232 :    
233 :     sub get_table_by_key {
234 :     my ($self,$Key,$HashColumn) = @_;
235 :    
236 :     my $NewTable = $self->clone_table_def();
237 :     my @Rows = $self->get_rows_by_key($Key,$HashColumn);
238 :     for (my $i=0; $i < @Rows; $i++) {
239 :     $NewTable->add_row($Rows[$i]);
240 :     }
241 :    
242 :     return $NewTable;
243 :     }
244 :    
245 :     =head3 get_hash_column_keys
246 :     Definition:
247 :     my @HashKeys = $TableObj->get_hash_column_keys($HashColumn);
248 :     Description:
249 :     Returns the list of the keys stored in the hash of the values in the column labeled $HashColumn.
250 :     Example:
251 :     my @HashKeys = $TableObj->get_hash_column_keys("Media");
252 :     =cut
253 :    
254 :     sub get_hash_column_keys {
255 :     my ($self,$HashColumn) = @_;
256 :     if (defined($self->{"hash columns"}->{$HashColumn})) {
257 :     return keys(%{$self->{"hash columns"}->{$HashColumn}});
258 :     }
259 :     return ();
260 :     }
261 :    
262 :     =head3 add_row
263 :     Definition:
264 :     $TableObj->add_row($row_object);
265 :     Description:
266 :     Adds a row to the table.
267 :     Example:
268 :     $TableObj->add_row({"COLUMN 1" => ["A"],"COLUMN 2" => ["B"]});
269 :     =cut
270 :    
271 :     sub add_row {
272 :     my ($self,$RowObject,$RowIndex) = @_;
273 :     if (defined($RowIndex) && $RowIndex == 0) {
274 :     unshift(@{$self->{"array"}},$RowObject);
275 :     } else {
276 :     push(@{$self->{"array"}},$RowObject);
277 :     }
278 :     my @HashHeadings = $self->hash_headings();
279 :     foreach my $HashHeading (@HashHeadings) {
280 :     if (defined($RowObject->{$HashHeading})) {
281 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
282 :     push(@{$self->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
283 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$RowObject);
284 :     }
285 :     }
286 :     }
287 :     return $RowObject;
288 :     }
289 :    
290 :     =head3 sort_rows
291 :     Definition:
292 :     $TableObj->sort_rows($sortcolumn);
293 :     Description:
294 :     Sorts the rows in the table by the specified column
295 :     Example:
296 :     =cut
297 :    
298 :     sub sort_rows {
299 :     my ($self,$sortcolumn) = @_;
300 :    
301 :     @{$self->{"array"}} = sort { $a->{$sortcolumn}->[0] <=> $b->{$sortcolumn}->[0] } @{$self->{"array"}};
302 :     }
303 :    
304 :     =head3 replace_row
305 :     Definition:
306 :     $TableObj->replace_row($OriginalRow,$NewRow);
307 :     Description:
308 :     Replaces the original row in the table with the new row.
309 :     Example:
310 :     =cut
311 :    
312 :     sub replace_row {
313 :     my ($self,$OriginalRow,$NewRow) = @_;
314 :    
315 :     for (my $i=0; $i < $self->size(); $i++) {
316 :     if ($self->get_row($i) == $OriginalRow) {
317 :     $self->{"array"}->[$i] = $NewRow;
318 :     last;
319 :     }
320 :     }
321 :     }
322 :    
323 :     =head3 add_row_copy
324 :     Definition:
325 :     $TableObj->add_row_copy($OriginalRow,$NewRow);
326 :     Description:
327 :     Replaces the original row in the table with the new row.
328 :     Example:
329 :     =cut
330 :    
331 :     sub add_row_copy {
332 :     my ($self,$OriginalRow) = @_;
333 :    
334 :     my @HashKeys = keys(%{$OriginalRow});
335 :     my $NewRow;
336 :     foreach my $Key (@HashKeys) {
337 :     $NewRow->{$Key} = $OriginalRow->{$Key};
338 :     }
339 :    
340 :     $self->add_row($NewRow);
341 :     return $NewRow;
342 :     }
343 :    
344 :     =head3 add_data
345 :     Definition:
346 :     $TableObj->add_data($Row,"TEST",1,1);
347 :     Description:
348 :     Deletes a row from the table.
349 :     Example:
350 :     $TableObj->delete_row(1);
351 :     =cut
352 :    
353 :     sub add_data {
354 :     my ($self,$RowObject,$Heading,$Data,$Unique) = @_;
355 :    
356 :     #First checking that the input row exists
357 : chenry 1.9 if (!defined($RowObject) || !defined($Data)) {
358 : parrello 1.8 return -1;
359 :     }
360 :    
361 :     if (ref($Data) eq 'ARRAY') {
362 :     my $Indecies;
363 :     for (my $i=0; $i < @{$Data}; $i++) {
364 :     $Indecies->[$i] = $self->add_data($RowObject,$Heading,$Data->[$i],$Unique);
365 :     }
366 :     return $Indecies;
367 :     }
368 :    
369 :     #Now checking if the heading exists in the row
370 :     if (defined($Unique) && $Unique == 1 && defined($RowObject->{$Heading})) {
371 :     for (my $i=0; $i < @{$RowObject->{$Heading}}; $i++) {
372 :     if ($RowObject->{$Heading}->[$i] eq $Data) {
373 :     return $i;
374 :     }
375 :     }
376 :     }
377 :    
378 :     #Adding the data
379 :     push(@{$RowObject->{$Heading}},$Data);
380 :     my @HashHeadings = $self->hash_headings();
381 :     foreach my $HashHeading (@HashHeadings) {
382 :     if ($HashHeading eq $Heading) {
383 :     push(@{$self->{$Data}},$RowObject);
384 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$Data}},$RowObject);
385 :     last;
386 :     }
387 :     }
388 :     my $Index = (@{$RowObject->{$Heading}}-1);
389 :    
390 :     return $Index;
391 :     }
392 :    
393 :     =head3 remove_data
394 :     Definition:
395 :     $TableObj->remove_data($Row,"HEADING","TEST");
396 :     Description:
397 :     Deletes a element of data from the input row
398 :     Example:
399 :     $TableObj->remove_data(1);
400 :     =cut
401 :    
402 :     sub remove_data {
403 :     my ($self,$RowObject,$Heading,$Data) = @_;
404 :    
405 :     #First checking that the input row exists
406 :     if (!defined($RowObject)) {
407 :     return 0;
408 :     }
409 :    
410 :     #Now checking if the heading exists in the row
411 :     if (defined($RowObject->{$Heading})) {
412 :     for (my $i=0; $i < @{$RowObject->{$Heading}}; $i++) {
413 :     if ($RowObject->{$Heading}->[$i] eq $Data) {
414 :     splice(@{$RowObject->{$Heading}},$i,1);
415 :     $i--;
416 :     }
417 :     }
418 :     if (defined($self->{"hash columns"}->{$Heading}) && defined($self->{"hash columns"}->{$Heading}->{$Data})) {
419 :     if (@{$self->{"hash columns"}->{$Heading}->{$Data}} == 1) {
420 :     delete $self->{"hash columns"}->{$Heading}->{$Data};
421 :     } else {
422 :     for (my $j=0; $j < @{$self->{"hash columns"}->{$Heading}->{$Data}}; $j++) {
423 :     if ($self->{"hash columns"}->{$Heading}->{$Data}->[$j] eq $RowObject) {
424 :     splice(@{$self->{"hash columns"}->{$Heading}->{$Data}},$j,1);
425 :     $j--;
426 :     }
427 :     }
428 :     }
429 :     }
430 :     }
431 :    
432 :     return 1;
433 :     }
434 :    
435 :     =head3 row_index
436 :     Definition:
437 :     $TableObj->row_index($Row);
438 :     Description:
439 :     Returns the index in the table where the input row is stored.
440 :     This only works if the input $Row object was pulled from the table using one of the get_row functions.
441 :     Returns undef if the row could not be found.
442 :     Example:
443 :     $TableObj->row_index($Row);
444 :     =cut
445 :    
446 :     sub row_index {
447 :     my ($self,$Row) = @_;
448 :    
449 :     for (my $i=0; $i < $self->size(); $i++) {
450 :     if ($self->get_row($i) == $Row) {
451 :     return $i;
452 :     }
453 :     }
454 :    
455 :     return undef;
456 :     }
457 :    
458 :     =head3 delete_row_by_key
459 :     Definition:
460 :     $TableObj->delete_row_by_key($Key,$Heading);
461 :     Description:
462 :     Deletes a row from the table based on the input key and heading that the key will be stored under.
463 :     Returns 1 if a row was found and deleted. Returns 0 if no row was found.
464 :     Example:
465 :     $TableObj->delete_row_by_key("Core83333.1","Model ID");
466 :     =cut
467 :    
468 :     sub delete_row_by_key {
469 :     my ($self,$Key,$Heading) = @_;
470 :    
471 :     my $Row = $self->get_row_by_key($Key,$Heading);
472 :     if (defined($Row)) {
473 :     $self->delete_row($self->row_index($Row));
474 :     return 1;
475 :     }
476 :     return 0;
477 :     }
478 :    
479 :     =head3 clone_table_def
480 :     Definition:
481 :     my $NewTable = $TableObj->get_clone_table();
482 :     Description:
483 :     Returns a new *empty* table with the same headings, hash headings, and delimiters as the input table.
484 :     Example:
485 :     my $NewTable = $TableObj->get_clone_table();
486 :     =cut
487 :    
488 :     sub clone_table_def {
489 :     my ($self) = @_;
490 :    
491 :     my $HeadingRef;
492 :     push(@{$HeadingRef},$self->headings());
493 :     my $HashHeadingRef;
494 :     push(@{$HashHeadingRef},$self->hash_headings());
495 :    
496 :     my $TableObj = FIGMODELTable->new($HeadingRef,$self->filename(),$HashHeadingRef,$self->delimiter(),$self->item_delimiter(),$self->{"file IO settings"}->{"file prefix"}->[0]);
497 :     return $TableObj;
498 :     }
499 :    
500 :     =head3 clone_row
501 :     Definition:
502 :     my $NewRow = $TableObj->clone_row($Index);
503 :     Description:
504 :     Returns an exact copy of row located at $Index
505 :     Example:
506 :     my $NewRow = $TableObj->clone_row(5);
507 :     =cut
508 :    
509 :     sub clone_row {
510 :     my ($self,$Index) = @_;
511 :    
512 :     my @Headings = $self->headings();
513 :     my $NewRow;
514 :     for (my$k=0; $k < @Headings; $k++) {
515 :     if (defined($self->get_row($Index)->{$Headings[$k]})) {
516 :     push(@{$NewRow->{$Headings[$k]}},@{$self->get_row($Index)->{$Headings[$k]}});
517 :     }
518 :     }
519 :    
520 :     return $NewRow;
521 :     }
522 :    
523 :     =head3 delete_row
524 :     Definition:
525 :     $TableObj->delete_row($i);
526 :     Description:
527 :     Deletes a row from the table.
528 :     Example:
529 :     $TableObj->delete_row(1);
530 :     =cut
531 :    
532 :     sub delete_row {
533 :     my ($self,$RowIndex) = @_;
534 :     my @HashHeadings = $self->hash_headings();
535 :     foreach my $HashHeading (@HashHeadings) {
536 :     my $RowObject = $self->get_row($RowIndex);
537 :     if (defined($RowObject->{$HashHeading})) {
538 :     for (my $i=0; $i < @{$RowObject->{$HashHeading}}; $i++) {
539 :     if (defined($self->{$RowObject->{$HashHeading}->[$i]})) {
540 :     for (my $j =0; $j < @{$self->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
541 :     if ($self->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
542 :     if ($j == 0 && @{$self->{$RowObject->{$HashHeading}->[$i]}} == 1) {
543 :     delete $self->{$RowObject->{$HashHeading}->[$i]};
544 :     last;
545 :     } else {
546 :     splice(@{$self->{$RowObject->{$HashHeading}->[$i]}},$j,1);
547 :     $j--;
548 :     }
549 :     }
550 :     }
551 :     }
552 :     if (defined($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]})) {
553 :     for (my $j =0; $j < @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}}; $j++) {
554 :     if ($self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}->[$j] eq $RowObject) {
555 :     if ($j == 0 && @{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}} == 1) {
556 :     delete $self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]};
557 :     last;
558 :     } else {
559 :     splice(@{$self->{"hash columns"}->{$HashHeading}->{$RowObject->{$HashHeading}->[$i]}},$j,1);
560 :     $j--;
561 :     }
562 :     }
563 :     }
564 :     }
565 :     }
566 :     }
567 :     }
568 :     splice(@{$self->{"array"}},$RowIndex,1);
569 :     }
570 :    
571 :     =head3 add_headings
572 :     Definition:
573 :     $TableObj->add_headings(@Headings);
574 :     Description:
575 :     Adds new headings to the table. This is needed to get the table to print the data under the new heading.
576 :     Example:
577 :     $TableObj->add_headings("Notes");
578 :     =cut
579 :    
580 :     sub add_headings {
581 :     my ($self,@Headings) = @_;
582 :    
583 :     foreach my $Heading (@Headings) {
584 :     #First check if the heading already exists
585 :     foreach my $ExistingHeading ($self->headings()) {
586 :     if ($Heading eq $ExistingHeading) {
587 :     $Heading = "";
588 :     last;
589 :     }
590 :     }
591 :     if ($Heading ne "") {
592 :     push(@{$self->{"file IO settings"}->{"orderedkeys"}},$Heading);
593 :     }
594 :     }
595 :     }
596 :    
597 : chenry 1.11 =head3 add_hashheadings
598 :     Definition:
599 :     $TableObj->add_hashheadings(@Headings);
600 :     Description:
601 :     Adds new hash headings to the table. This is needed to get the table to print the data under the new heading.
602 :     Example:
603 :     $TableObj->add_hashheadings("Notes");
604 :     =cut
605 :    
606 :     sub add_hashheadings {
607 :     my ($self,@HashHeadings) = @_;
608 :    
609 :     foreach my $HashHeading (@HashHeadings) {
610 :     if (!defined($self->{"hash columns"}->{$HashHeading})) {
611 :     $self->{"hash columns"}->{$HashHeading} = {};
612 :     for (my $i=0; $i < $self->size(); $i++) {
613 :     my $Row = $self->get_row($i);
614 :     if (defined($Row->{$HashHeading})) {
615 :     for (my $j=0; $j < @{$Row->{$HashHeading}}; $j++) {
616 :     push(@{$self->{"hash columns"}->{$HashHeading}->{$Row->{$HashHeading}->[$j]}},$Row);
617 :     }
618 :     }
619 :     }
620 :     }
621 :     }
622 :     }
623 :    
624 : parrello 1.8 =head3 save
625 :     Definition:
626 :     $TableObj->save($filename,$delimiter,$itemdelimiter,$prefix);
627 :     Description:
628 :     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).
629 :     All arguments are optional. If arguments are not supplied, the values used to read the table from file will be used.
630 :     Example:
631 :     $TableObj->save("/vol/Table.txt",";","|","REACTIONS");
632 :     =cut
633 :    
634 :     sub save {
635 :     my ($self,$filename,$delimiter,$itemdelimiter,$prefix) = @_;
636 :     if (defined($filename)) {
637 :     $self->{"file IO settings"}->{"filename"}->[0] = $filename;
638 :     }
639 :     if (defined($delimiter)) {
640 :     $self->{"file IO settings"}->{"delimiter"}->[0] = $delimiter;
641 :     }
642 :     if (defined($itemdelimiter)) {
643 :     $self->{"file IO settings"}->{"item delimiter"}->[0] = $itemdelimiter;
644 :     }
645 :     if (defined($prefix)) {
646 :     $self->{"file IO settings"}->{"file prefix"}->[0] = $prefix;
647 :     }
648 : chenry 1.11 $self->print_table_to_file();
649 :     }
650 :    
651 :     sub print_table_to_file {
652 :     my ($self) = @_;
653 :    
654 :     #Checking that a filename exists
655 :     if (!defined($self->{"array"}) || !defined($self->{"file IO settings"}->{"filename"}) || !defined($self->{"file IO settings"}->{"orderedkeys"})) {
656 :     return -1;
657 :     }
658 :    
659 :     my $Filename = $self->{"file IO settings"}->{"filename"}->[0];
660 :     my $Delimiter = ";";
661 :     my $ItemDelimiter = "|";
662 :     my $Prefix = "";
663 :     if (defined($self->{"file IO settings"}->{"delimiter"})) {
664 :     $Delimiter = $self->{"file IO settings"}->{"delimiter"}->[0];
665 :     if ($Delimiter eq "\\|" || $Delimiter eq "\|") {
666 :     $Delimiter = "|";
667 :     } elsif ($Delimiter eq "\\t") {
668 :     $Delimiter = "\t";
669 :     }
670 :     }
671 :     if (defined($self->{"file IO settings"}->{"item delimiter"})) {
672 :     $ItemDelimiter = $self->{"file IO settings"}->{"item delimiter"}->[0];
673 :     if ($ItemDelimiter eq "\\|" || $ItemDelimiter eq "\|") {
674 :     $ItemDelimiter = "|";
675 :     } elsif ($ItemDelimiter eq "\\t") {
676 :     $ItemDelimiter = "\t";
677 :     }
678 :     }
679 :     if (defined($self->{"file IO settings"}->{"file prefix"})) {
680 :     $Prefix = $self->{"file IO settings"}->{"file prefix"}->[0];
681 :     }
682 :    
683 :     #Opening the file
684 :     if (defined($self->{"file IO settings"}->{"append"})) {
685 :     if (!open (SAVINGTABLE, ">>$Filename")) {
686 :     return -1;
687 :     }
688 :     } else {
689 :     if (!open (SAVINGTABLE, ">$Filename")) {
690 :     return -1;
691 :     }
692 :     }
693 :    
694 :     if (defined($Prefix)) {
695 :     print SAVINGTABLE $Prefix;
696 :     }
697 :     print SAVINGTABLE join($Delimiter,@{$self->{"file IO settings"}->{"orderedkeys"}})."\n";
698 :     for (my $i=0; $i < @{$self->{"array"}}; $i++) {
699 :     for (my $j=0; $j < @{$self->{"file IO settings"}->{"orderedkeys"}}; $j++) {
700 :     if ($j > 0) {
701 :     print SAVINGTABLE $Delimiter;
702 :     }
703 :     if (defined($self->{"array"}->[$i]->{$self->{"file IO settings"}->{"orderedkeys"}->[$j]})) {
704 :     if(ref($self->{"array"}->[$i]->{$self->{"file IO settings"}->{"orderedkeys"}->[$j]}) eq 'ARRAY') {
705 :     print SAVINGTABLE join($ItemDelimiter,@{$self->{"array"}->[$i]->{$self->{"file IO settings"}->{"orderedkeys"}->[$j]}});
706 :     } else {
707 :     print SAVINGTABLE $self->{"array"}->[$i]->{$self->{"file IO settings"}->{"orderedkeys"}->[$j]};
708 :     }
709 :     }
710 :     }
711 :     print SAVINGTABLE "\n";
712 :     }
713 :     close (SAVINGTABLE);
714 : parrello 1.8 }
715 :    
716 : chenry 1.10 =head3 html_print
717 :     Definition:
718 :     string::html_text = FIGMODELTable::my_table->html_print(void);
719 :     Description:
720 :     This function returns the table contents in html format for simple display on a webpage.
721 :     Example:
722 :     =cut
723 :    
724 :     sub html_print {
725 :     my ($self) = @_;
726 :    
727 :     #Printing the table headings first
728 :     my $html = "<table><tr>";
729 :     my @Headings = $self->headings();
730 :     for (my $i=0; $i < @Headings; $i++) {
731 :     $html .= "<th align='left'>".$Headings[$i]."</th>";
732 :     }
733 :     $html .= "</tr>\n";
734 :    
735 :     #Printing the table rows
736 :     for (my $j=0; $j < $self->size(); $j++) {
737 :     my $Row = $self->get_row($j);
738 :     $html .= "<tr>";
739 :     for (my $i=0; $i < @Headings; $i++) {
740 :     $html .= "<td>";
741 :     if (defined($Row->{$Headings[$i]})) {
742 :     $html .= join("|",@{$Row->{$Headings[$i]}});
743 :     }
744 :     $html .= "</td>";
745 :     }
746 :     $html .= "</tr>\n";
747 :     }
748 :     $html .= "</table>";
749 :    
750 :     return $html;
751 :     }
752 :    
753 : parrello 1.8 =head3 load
754 :     Definition:
755 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
756 :     Description:
757 :    
758 :     Example:
759 :     my $Table = load_table($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns);
760 :     =cut
761 :    
762 :     sub load_table {
763 :     my ($Filename,$Delimiter,$ItemDelimiter,$HeadingLine,$HashColumns) = @_;
764 :    
765 :     #Checking that the table file exists
766 :     if (!-e $Filename) {
767 :     return undef;
768 :     }
769 :    
770 :     #Sanity checking input values
771 :     if (!defined($HeadingLine) || $HeadingLine eq "") {
772 :     $HeadingLine = 0;
773 :     }
774 :     if (!defined($Delimiter) || $Delimiter eq "") {
775 :     $Delimiter = ";";
776 :     }
777 :     if ($Delimiter eq "|") {
778 :     $Delimiter = "\\|";
779 :     }
780 :     if (!defined($ItemDelimiter) || $ItemDelimiter eq "") {
781 :     $ItemDelimiter = "";
782 :     } elsif ($ItemDelimiter eq "|") {
783 :     $ItemDelimiter = "\\|";
784 :     }
785 :    
786 :     #Loading the data table
787 :     my $Prefix;
788 :     my @Headings;
789 :     if (!open (TABLEINPUT, "<$Filename")) {
790 :     return undef;
791 :     }
792 :     my $Line = <TABLEINPUT>;
793 :     for (my $i=0; $i < $HeadingLine; $i++) {
794 :     $Prefix .= $Line;
795 :     $Line = <TABLEINPUT>;
796 :     }
797 :     chomp($Line);
798 :     @Headings = split(/$Delimiter/,$Line);
799 :     my $HeadingRef;
800 :     push(@{$HeadingRef},@Headings);
801 :     my $Table = new FIGMODELTable($HeadingRef,$Filename,$HashColumns,$Delimiter,$ItemDelimiter,$Prefix);
802 :    
803 :     while ($Line = <TABLEINPUT>) {
804 :     chomp($Line);
805 :     my @Data = split(/$Delimiter/,$Line);
806 :     my $ArrayRefHashRef;
807 :     for (my $i=0; $i < @Headings; $i++) {
808 :     if (defined($Data[$i]) && length($Data[$i]) > 0) {
809 :     if (defined($ItemDelimiter) && length($ItemDelimiter) > 0) {
810 :     my @TempArray = split(/$ItemDelimiter/,$Data[$i]);
811 :     foreach my $Item (@TempArray) {
812 :     push(@{$ArrayRefHashRef->{$Headings[$i]}},$Item);
813 :     }
814 :     } else {
815 :     $ArrayRefHashRef->{$Headings[$i]}->[0] = $Data[$i];
816 :     }
817 :     }
818 :     }
819 :     $Table->add_row($ArrayRefHashRef);
820 :     }
821 :     close(TABLEINPUT);
822 :    
823 :     return $Table;
824 :     }
825 :    
826 : chenry 1.11 =head3 connect_to_db
827 :     Definition:
828 :     integer::status = FIGMODELTable->connect_to_db(string::table name,string::database,string::user,host::host)
829 :     Description:
830 :     Connects to the database for input and output for the table to and from the database
831 :     =cut
832 :    
833 :     sub connect_to_db {
834 :     my ($self,$Table,$Database,$Username,$Host,$SubTableHeadings,$TableKey) = @_;
835 :    
836 :     #Getting DB data from arguments
837 :     my $Changed = 0;
838 :     if (!defined($Host)) {
839 :     $Host = $self->{_host};
840 :     } elsif (!defined($self->{_host}) || $Host ne $self->{_host}) {
841 :     $Changed = 1;
842 :     }
843 :     if (!defined($Table)) {
844 :     $Table = $self->{_table};
845 :     } elsif (!defined($self->{_table}) || $Table ne $self->{_table}) {
846 :     $Changed = 1;
847 :     }
848 :     if (!defined($Database)) {
849 :     $Database = $self->{_database};
850 :     } elsif (!defined($self->{_database}) || $Database ne $self->{_database}) {
851 :     $Changed = 1;
852 :     }
853 :     if (!defined($Username)) {
854 :     $Username = $self->{_user};
855 :     } elsif (!defined($self->{_user}) || $Username ne $self->{_user}) {
856 :     $Changed = 1;
857 :     }
858 :     if (!defined($Username)) {
859 :     $Username = $self->{_user};
860 :     } elsif (!defined($self->{_user}) || $Username ne $self->{_user}) {
861 :     $Changed = 1;
862 :     }
863 :     if (defined($SubTableHeadings)) {
864 :     for (my $i=0; $i < @{$SubTableHeadings}; $i++) {
865 :     $self->{_subheadings}->{$SubTableHeadings->[$i]} = 1;
866 :     }
867 :     }
868 :     if (defined($TableKey)) {
869 :     $self->{_tablekey} = $TableKey;
870 :     }
871 :    
872 :     #If no change, then we leave
873 :     if ($Changed == 0) {
874 :     return 1;
875 :     }
876 :    
877 :     #If the connection data was changed, we reconnect to the database
878 :     if (defined($self->{_dbhandle})) {
879 :     #Closing any previous connection
880 :     delete $self->{_dbhandle};
881 :     }
882 :    
883 :     #Checking if DBMaster is even available
884 :     eval {
885 :     require "DBMaster.pm";
886 :     };
887 :     if ($@) {
888 :     print STDERR "FIGMODELTable:connect_to_db:Cannot connect to database because DBMaster module is unavailable\n";
889 :     return -1;
890 :     }
891 :    
892 :     $self->{_dbhandle} = DBMaster->new(-database => $Database, -user => $Username, -host => $Host);
893 :     $self->{_dbtable} = $self->{_dbhandle}->$Table;
894 :    
895 :     #Check that the connection was successful
896 :     if (!defined($self->{_dbhandle})) {
897 :     print STDERR "FIGMODELTable:save_to_db: could not connect to database with ".$Database.";".$Table.";".$Username.";".$Host."\n";
898 :     return -1;
899 :     }
900 :    
901 :     return 1;
902 :     }
903 :    
904 :     =head3 save_to_db
905 :     Definition:
906 :     integer::status = FIGMODELTable->save_to_db(string::table name,string::database,string::user,host::host)
907 :     Description:
908 :     Syncs the FIGMODELTable and the database
909 :     =cut
910 :    
911 :     sub save_to_db {
912 :     my ($self,$Table,$Database,$Username,$Host,$SubTableHeadings,$TableKey) = @_;
913 :    
914 :     #Connecting to database
915 :     if ($self->connect_to_db($Table,$Database,$Username,$Host,$SubTableHeadings,$TableKey) == -1) {
916 :     return -1;
917 :     }
918 :    
919 :     #Saving the table
920 :     for (my $i=0; $i < $self->size(); $i++) {
921 :     my $Row = $self->get_row($i);
922 :     $self->update_db_row($Row);
923 :     }
924 :    
925 :     return 1;
926 :     }
927 :    
928 :     =head3 update_db_row
929 :     Definition:
930 :     integer::status = FIGMODELTable->update_db_row(FIGMODELTable::Row::row to be updated)
931 :     Description:
932 :     Updates the input row in the database. Returns -1 upon failure, 0 if there was no change, 1 if the row is new, 2 if the row was changed
933 :     =cut
934 :    
935 :     sub update_db_row {
936 :     my ($self,$row) = @_;
937 :    
938 :     #Checking that the database is connected
939 :     if (!defined($self->{_dbhandle})) {
940 :     print STDERR "FIGMODELTable:update_db_row: need to be connected to database prior to update of row.\n";
941 :     return -1;
942 :     }
943 :    
944 :     #Checking if a row with the same table key already exists in the table
945 :     if (!defined($row->{_dbhandle}) && defined($self->{_tablekey}) && defined($row->{$self->{_tablekey}}->[0])) {
946 :     $row->{_dbhandle} = $self->{_dbtable}->init( { $self->{_tablekey} => $row->{$self->{_tablekey}}->[0] } );
947 :     }
948 :    
949 :     #Checking if the row has a dbhandle
950 :     if (defined($row->{_dbhandle})) {
951 :     #This is not a new row-first we check if anything has changed
952 :     } else {
953 :     #First we add the base object to the table on the server
954 :     my $NewObject;
955 :     my @Headings = $self->headings();
956 :     for (my $i=0; $i < @Headings; $i++) {
957 :     if (defined($row->{$Headings[$i]}->[0])) {
958 :     if (!defined($self->{_subheadings}->{$Headings[$i]})) {
959 :     $NewObject->{$Headings[$i]} = join($self->item_delimiter(),@{$row->{$Headings[$i]}});
960 :     }
961 :     }
962 :     }
963 :     $row->{_dbhandle} = $self->{_dbtable}->create($NewObject);
964 :     #Now we add all of the subtable objects
965 :     for (my $i=0; $i < @Headings; $i++) {
966 :     if (defined($row->{$Headings[$i]}->[0])) {
967 :     if (defined($self->{_subheadings}->{$Headings[$i]})) {
968 :     #Adding the subtable rows to the database
969 :     for (my $j=0; $j < @{$row->{$Headings[$i]}}; $j++) {
970 :     #my $Object = $self->{_dbtable}->init( { $self->{_tablekey} => $row->{$self->{_tablekey}}->[0] } );
971 :     }
972 :     }
973 :     }
974 :     }
975 :     }
976 :    
977 :     return 1;
978 :     }
979 :    
980 : chenry 1.12 =head3 set_metadata
981 :     Definition:
982 :     FIGMODELTable->set_metadata(string::key,string::data);
983 :     Description:
984 :     Sets a specified metadata for the table
985 :     =cut
986 :     sub set_metadata {
987 :     my ($self,$key,$data) = @_;
988 :     $self->{_metadata}->{$key} = $data;
989 :     }
990 :    
991 :     =head3 get_meta_data
992 :     Definition:
993 :     string::data = FIGMODELTable->get_meta_data(string::key);
994 :     Description:
995 :     Sets a specified metadata for the table
996 :     =cut
997 :     sub get_meta_data {
998 :     my ($self,$key,$data) = @_;
999 :     return $self->{_metadata}->{$key};
1000 :     }
1001 :    
1002 : devoid 1.13 =head3 add_column
1003 :     Definition:
1004 :     FIGMODELTable->add_column(array, string);
1005 :     FIGMODELTable->add_column(function(hash), string);
1006 :     Descrition:
1007 :     Adds a column to the table under column name string. If the first
1008 :     argument is an array, it places the content of the i-th elment of
1009 :     the array in row i for the new column. If the first argument is a
1010 :     function operating over a hash, the output of that function
1011 :     run over the i-th row is placed in the new column for row i.
1012 :     Just be sure to pass function sub foo { ... } as \&PACKAGE::PATH::foo
1013 :     =cut
1014 :     sub add_column {
1015 :     my ($self, $arg, $column_name) = @_;
1016 :     if( ref($arg) == 'CODE' ) {
1017 :     # $arg is a function, apply to all rows
1018 :     my @columnData = [];
1019 :     for( my $i = 0; $i < $self->size(); $i++ ) {
1020 :     my $row = $self->get_row($i);
1021 :     my $entry = &$arg($row);
1022 :     $row->{$column_name} = $entry;
1023 :     }
1024 :     } elsif ( ref($arg) == 'ARRAY' ) {
1025 :     for( my $i = 0; $i < $self->size(); $i++ ) {
1026 :     if( $i > @{$arg} ) { return; }
1027 :     my $row = $self->get_row($i);
1028 :     $row->{$column_name} = $arg->[$i];
1029 :     }
1030 :     }
1031 :     }
1032 :    
1033 :    
1034 :     =head3 remove_column
1035 :     Defintion:
1036 :     FIGMODELTable->remove_column(string)
1037 :     Description:
1038 :     Removes column whose name matches string.
1039 :     =cut
1040 :     sub remove_column {
1041 :     my ($self, $column_name) = @_;
1042 :     for( my $i = 0; $i < $self->size(); $i++ ) {
1043 :     my $row = $self->get_row($i);
1044 :     if(defined($row->{$column_name})) {
1045 :     delete($row->{$column_name});
1046 :     }
1047 :     }
1048 :     }
1049 :    
1050 : chenry 1.12
1051 :    
1052 :    
1053 : parrello 1.8 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3