[COMMIT LOGREPORT] service/all/lib/Lire DlfCategoriser.pm,1.4,1.5

[Francis J. Lacoste]

Update of /cvsroot/logreport/service/all/lib/Lire
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12415/all/lib/Lire

Modified Files:
	DlfCategoriser.pm 
Log Message:
Added a finalise() method to the DlfCategoriser API.


Index: DlfCategoriser.pm
===================================================================
RCS file: /cvsroot/logreport/service/all/lib/Lire/DlfCategoriser.pm,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DlfCategoriser.pm	7 Jun 2004 17:02:08 -0000	1.4
+++ DlfCategoriser.pm	13 Jun 2005 16:19:47 -0000	1.5
@@ -83,6 +83,9 @@
         }
     }
 
+    eval { $self->finalise( $config ) };
+    $process->error( "Error during initialise: $@" ) if ( $@ );
+
     return;
 }
 
@@ -90,7 +93,7 @@
 
 =head2 initialise( $config )
 
-This method is called before the categorise() method is called. 
+This method is called before the categorise() method is called.
 
 The $config parameter contains configuration data that was specified
 in the AnalysisJob for that analyser. To register configuration
@@ -119,6 +122,27 @@
     croak "categorise() not implemented by ", ref $_[0] || $_[0];
 }
 
+=pod
+
+=head2 finalise( $config )
+
+This method is called after all the DLF records were categorised. 
+
+The $config parameter contains configuration data that was specified
+in the AnalysisJob for that analyser. To register configuration
+specification for you DlfCategoriser, you just need to define a
+configuration specification under the name
+I<analyser_name>_properties. This should be either a RecordSpec or
+ObjectSpec.
+
+The default implementation does nothing.
+
+=cut
+
+sub finalise { 
+    # Empty method
+}
+
 # keep perl happy
 1;
 

-- 
To UNSUBSCRIBE, email to commit-request at logreport.org with a subject of 
"unsubscribe". Trouble? Send an email with subject "help" to 
commit-request at logreport.org