Lire::DlfCategoriser3pm
Base class for analysers which produce extended dlf records.
Usage
use base qw/ Lire::DlfCategoriser /;sub categorise {my ( $self, $dlf ) = @_;# Adds the extended field to DLF.return;}
Overview
This package defines a base class that can be use for Lire::DlfAnalyser which writes to an ExtendedSchema. The categoriser only have to implement the categorise() method instead of the more generic analyse().
Meta information methods
The Lire::DlfCategoriser should implement the same meta-information methods than the Lire::DlfAnalyser (name(), src_schema(), dst_schema(), title(), description()).
Implementation methods
The categoriser does its job using the initialise() and categorise() methods.
analyse( $process, $config )
The Lire::DlfCategoriser implements the analyse() method. It will run the query on the src_schema() using the correct filter and will call categorise() on each DLF returned. The extended fiels will then be written to dst_schema(). Errors should be reported by dying.
initialise( $config )
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 specification for you DlfCategoriser, you just need to define a configuration specification under the name analyser_name_properties. This should be either a RecordSpec or ObjectSpec.
categorise( $dlf )
Called one for each DLf records that should be categorised. The categoriser should add the extended fields directly to the $dlf hash reference.
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 analyser_name_properties. This should be either a RecordSpec or ObjectSpec.
The default implementation does nothing.
Version
$Id: DlfCategoriser.pm,v 1.6 2006/07/23 13:16:28 vanbaal Exp $
Releases
6 releases since Debian 3.1 (Sarge); the text changed 5 times.