DlfAnalyserProcess(3pm)

NAME
Lire::DlfAnalyseProcess - Object that controls the analysis process.

SYNOPSIS
  use Lire::DlfStore;
  use Lire::DlfAnalyserProcess;

  my $store = Lire::DlfStore->open( "store" );

  my $process = new Lire::DlfAnalyserProcess( $store, $analyser_name,
                                              $analyser_config, $dlf_source );

  $process->run_analysis_job();

  print "DLF records created: ", $process->dlf_count(),    "\n";
  print "Errors encountered: ",  $process->errors_count(), "\n";

DESCRIPTION
This object encapsulates the Lire DLF analysis process. It takes as a Lire::DlfStore, the name of the analyser, its configuration and optionally, a dlf_source ID. When a dlf_source is used, the analysis will only be done using the DLF coming from that source.

The object provides the API to the converter. Methods are also available to query information on the conversion process.

new( $store, $analyser_name, $analyser_config, [ $dlf_source ] );
Create a Lire::DlfAnalysisProcess.

  run_analysis_job()
Import the log data from ImportJob as DLF. This method will throw an exception if it is called more than once.

  job_id()
Returns the job identifier associated to this process.

  dlf_store()
Returns the Lire::DlfStore in which this conversion process is storing the DLF records.

  dlf_source()
Returns the source from which the DLF should come in the src_schema to be analysed.

  dlf_analyser()
Returns the name of the analyser which will be run.

  dlf_analyser_config()
Returns the analysis configuration data that should be used by the converter.

  dlf_count()
Returns the number of DLF records created.

  error_count()
Returns the number of errors encountered in the conversion process.

  source_filter()
Returns a Lire::FilterExpr which should be used to limit the DLF records to analyse.

This method returns null if the whole DLF stream should be analysed.

API FOR THE DLF ANALYSERS
This is the object that encapsulates the DLF implementation and hides the complexitity of the storage framework from the DLF analysers. It offers the following methods to the DLf converter.

  write_dlf( $dlf, [$related_to] )
This writes the $dlf DLF record conforming the $schema's schema in the Lire::DlfStore. $Dlf is an hash reference. Keys are the schema's field name. Undefined value means that this field isn't available in that record.

When writing to a derived schema, the $related_to parameter can be an arrayr reference containing the dlf_ids of the related record.

  error( $error_msg );
Method that should be used by the Lire::Analyser to report that an error was encountered during the analysis process. $error_msg should be used to report the nature of the error.

SEE ALSO
Lire::DlfStore(3pm) Lire::DlfAnalyser(3pm)

AUTHOR
Francis J. Lacoste <flacoste@logreport.org>

VERSION
$Id: DlfAnalyserProcess.pm,v 1.10 2006/07/23 13:16:28 vanbaal Exp $

COPYRIGHT
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.