Changeset 113

Timestamp:

12/11/05 17:52:32 (19 years ago)

Author:

thauvin

Message:

• fill doc

File:

• trunk/soft/ObsData/ObsData/Repository.pm (modified) (17 diffs, 1 prop)

trunk/soft/ObsData/ObsData/Repository.pm

@@ -15 +15 @@
 =head1 METHODS
 
-=head2 new
+=head2 ObsData::Repository
+
+=head3 new
+
+Create a new ObsData::Repository object
 
 =cut
@@ -55 +59 @@
 }
 
+=head3 save_status
+
+Save current information about parsed files into status file
+
+=cut
+
 sub save_status {
     my ($self) = @_;
@@ -68 +78 @@
 }
 
+=head3 loging($level, $msg, ...)
+
+Pass a message for loging to ObsData Object. See L<ObsData>
+
+=cut
+
 sub loging {
     my $self = shift;
@@ -73 +89 @@
 }
 
+=head2 ObsData::Repository::dir
+
+The child class to handle directory
+
+=cut
+
 package ObsData::Repository::dir;
 
 our @ISA = qw(ObsData::Repository);
+
+=head3 new
+
+=cut
 
 sub new {
@@ -84 +110 @@
     bless($or, $class);
 }
+
+=head3 findfile
+
+Return the list of files needing to be checked
+
+=cut
 
 sub findfile {
@@ -110 +142 @@
 }
 
+=head3 process
+
+Process all files in directory
+
+=cut
+
 sub process {
     my ($self) = @_;
@@ -131 +169 @@
 }
 
+=head2 ObsData::Repository::dir::archive
+
+Object to handle archive and to dispatch data
+
+=cut
+
 package ObsData::Repository::dir::archive;
 
 our @ISA = qw(ObsData::Repository);
+
+=head3 new
+
+=cut
 
 sub new {
@@ -153 +201 @@
     bless($or, $class);
 }
+
+=head3 load_archive
+
+Try to read archive, return 1 on success
+
+=cut
+
+sub load_archive {
+    my ($self) = @_;
+    if ($self->{Oarchive}) {
+        return 1;
+    } else {
+        $self->{Oarchive} = ObsData::Archive->new("$self->{dir}/$self->{archivefile}");
+        if ($self->{Oarchive}) {
+            $self->loging(0,
+                "Archive %s/%s properly load",
+                $self->{dir}, $self->{archivefile}
+            );
+            return 1;
+        } else {
+            $self->loging(4, 
+                "Can't handle archive %s/%s: %s, skipping",
+                $self->{dir}, $self->{archivefile},
+                ObsData::Archive->error
+            );
+            return 0;
+        }
+    }
+}
+
+=head3 checks
+
+=cut
 
 my $checks = {
@@ -216 +297 @@
         }
     },
+
+    data_extracted => sub {
+        my ($self, $datafile) = @_;
+        my $last_process = $self->{status}->val($self->{archivefile}, "data_processtime_$datafile");
+        if ($last_process) {
+            $self->loging(0, "%s/%s has been already processed at %s",
+                $self->{archivefile},
+                $datafile,
+                scalar(localtime($last_process)),
+            );
+        }
+        $last_process
+    },
 };
 
@@ -224 +318 @@
 #}
 
+=head3 do_check($check, @args)
+
+Perform $check with @args if exists and return result of check
+
+=cut
+
 sub do_check {
     my ($self, $check, @args) = @_;
@@ -237 +337 @@
 }
 
-sub do_continue {
-    my ($self, $why, @args) = @_;
-
-    if ($self->{interative_callback}) {
-        return $self->{interative_callback}->($self, $why, @args);
-    } else {
-        return $self->default_checks($why, @args);
-    }
-}
+=head3 default_checks($why, @args)
+
+Perform defaults checks
+
+=cut
 
 sub default_checks {
@@ -281 +377 @@
 }
 
-sub load_archive {
-    my ($self) = @_;
-    if ($self->{Oarchive}) {
-        return 1;
+=head3 do_continue($why, @args)
+
+Perform default or call the interactive callback.
+
+    $why is the reason of the call
+    @args are argument to passed to callback
+
+=cut
+
+sub do_continue {
+    my ($self, $why, @args) = @_;
+
+    if ($self->{interative_callback}) {
+        return $self->{interative_callback}->($self, $why, @args);
     } else {
-        $self->{Oarchive} = ObsData::Archive->new("$self->{dir}/$self->{archivefile}");
-        if ($self->{Oarchive}) {
-            $self->loging(0,
-                "Archive %s/%s properly load",
-                $self->{dir}, $self->{archivefile}
-            );
-            return 1;
-        } else {
-            $self->loging(4, 
-                "Can't handle archive %s/%s: %s, skipping",
-                $self->{dir}, $self->{archivefile},
-                ObsData::Archive->error
-            );
-            return 0;
-        }
-    }
-}
+        return $self->default_checks($why, @args);
+    }
+}
+
+=head3 list_archive
+
+Return archive content
+
+=cut
 
 sub list_archive {
@@ -310 +408 @@
     return $self->{Oarchive}->ls;
 }
+
+=head3 update_status
+
+Update status information about current archive
+
+=cut
 
 sub update_status {
@@ -325 +429 @@
 # Sub data function:
 
-sub data_lastcheck {
-    my ($self, $datafile) = @_;
-    my $last_process = $self->{status}->val($self->{archivefile}, "data_processtime_$datafile");
-    if ($last_process) {
-        $self->loging(0, "%s/%s has been already processed at %s",
-            $self->{archivefile},
-            $datafile,
-            scalar(localtime($last_process)),
-        );
-    }
-    $last_process
-}
+=head3 get_data_dest($datafile)
+
+Return the datatype and destination for $datafile
+
+=cut
 
 sub get_data_dest {
@@ -356 +453 @@
     return($t, $d);
 }
+
+=head3 extract_data($datafile, $datatype, $destfile)
+
+Extract data file into $destfile, $datafile is informationnal only.
+
+$datatype and $destfile are the result of L<get_data_dest>.
+
+A basic call is:
+    $o->extract_data($file, $self->get_data_dest($file));
+
+Return 1 on success
+
+=cut
 
 sub extract_data {
@@ -438 +548 @@
 }
 
+=head3 process
+
+Process all files in the archive
+
+=cut
+
 sub process {
     my ($self) = @_;
@@ -458 +574 @@
 }
 
+=head1 AUTHOR
+
+Olivier Thauvin <olivier.thauvin@aerov.jussieu.fr>
+
+=cut
+
 1;