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

Annotation of /FigKernelPackages/FIGMODELTable.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3