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

Diff of /Sprout/ERDBLoad.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.18, Mon Jul 10 09:06:46 2006 UTC revision 1.20, Thu Dec 6 14:58:03 2007 UTC
# Line 28  Line 28 
28    
29  =head3 new  =head3 new
30    
31  C<< my $erload = ERDBLoad->new($erdb, $relationName, $directory, $loadOnly, $ignore); >>      my $erload = ERDBLoad->new($erdb, $relationName, $directory, $loadOnly, $ignore);
32    
33  Begin loading an ERDB relation.  Begin loading an ERDB relation.
34    
# Line 108  Line 108 
108    
109  =head3 Ignore  =head3 Ignore
110    
111  C<< my $flag = $erload->Ignore; >>      my $flag = $erload->Ignore;
112    
113  Return TRUE if we are ignoring this table, else FALSE.  Return TRUE if we are ignoring this table, else FALSE.
114    
# Line 123  Line 123 
123    
124  =head3 Put  =head3 Put
125    
126  C<< my  = $erload->Put($field1, $field2, ..., $fieldN); >>      my  = $erload->Put($field1, $field2, ..., $fieldN);
127    
128  Write a line of data to the load file. This may also cause the load file to be closed  Write a line of data to the load file. This may also cause the load file to be closed
129  and data read into the table.  and data read into the table.
# Line 174  Line 174 
174    
175  =head3 Add  =head3 Add
176    
177  C<< my  = $stats->Add($statName, $value); >>      my  = $stats->Add($statName, $value);
178    
179  Increment the specified statistic.  Increment the specified statistic.
180    
# Line 205  Line 205 
205    
206  =head3 Finish  =head3 Finish
207    
208  C<< my $stats = $erload->Finish(); >>      my $stats = $erload->Finish();
209    
210  Finish loading the table. This closes the load file.  Finish loading the table. This closes the load file.
211    
# Line 231  Line 231 
231      return $self->{stats};      return $self->{stats};
232  }  }
233    
234    =head3 FinishAndLoad
235    
236        my $stats = $erload->FinishAndLoad();
237    
238    Finish the load and load the table, returning the statistics.
239    
240    =cut
241    
242    sub FinishAndLoad {
243        # Get the parameters.
244        my ($self) = @_;
245        # Finish the load file.
246        my $retVal = $self->Finish();
247        # Load the table.
248        my $newStats = $self->LoadTable();
249        # Accumulate the stats.
250        $retVal->Accumulate($newStats);
251        # Return the result.
252        return $retVal;
253    }
254    
255  =head3 RelName  =head3 RelName
256    
257  C<< my $name = $erload->RelName; >>      my $name = $erload->RelName;
258    
259  Name of the relation being loaded by this object.  Name of the relation being loaded by this object.
260    
# Line 246  Line 267 
267      return $self->{relName};      return $self->{relName};
268  }  }
269    
270    =head3 LoadTable
271    
272        my $stats = $erload->LoadTable();
273    
274    Load the database table from the load file and return a statistics object.
275    
276    =cut
277    
278    sub LoadTable {
279        # Get the parameters.
280        my ($self) = @_;
281        # Get the database object, the file name, and the relation name.
282        my $erdb = $self->{dbh};
283        my $fileName = $self->{fileName};
284        my $relName = $self->{relName};
285        # Load the table. The third parameter indicates this is a drop and reload.
286        my $retVal = $erdb->LoadTable($fileName, $relName, 1);
287        # Return the result.
288        return $retVal;
289    }
290    
291  1;  1;
292    

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.20

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3