.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "DlfAnalyserProcess 3pm"
.TH DlfAnalyserProcess 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::DlfAnalyseProcess \- Object that controls the analysis process.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  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(),    "\en";
\&  print "Errors encountered: ",  $process\->errors_count(), "\en";
.Ve
.SH DESCRIPTION
.IX Header "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.
.PP
The object provides the API to the converter. Methods are also
available to query information on the conversion process.
.ie n .SH "new( $store, $analyser_name, $analyser_config, [ $dlf_source ] );"
.el .SH "new( \f(CW$store\fP, \f(CW$analyser_name\fP, \f(CW$analyser_config\fP, [ \f(CW$dlf_source\fP ] );"
.IX Header "new( $store, $analyser_name, $analyser_config, [ $dlf_source ] );"
Create a Lire::DlfAnalysisProcess.
.SS \fBrun_analysis_job()\fP
.IX Subsection "run_analysis_job()"
Import the log data from ImportJob as DLF. This method will throw an
exception if it is called more than once.
.SS \fBjob_id()\fP
.IX Subsection "job_id()"
Returns the job identifier associated to this process.
.SS \fBdlf_store()\fP
.IX Subsection "dlf_store()"
Returns the Lire::DlfStore in which this conversion process is storing
the DLF records.
.SS \fBdlf_source()\fP
.IX Subsection "dlf_source()"
Returns the source from which the DLF should come in the src_schema to
be analysed.
.SS \fBdlf_analyser()\fP
.IX Subsection "dlf_analyser()"
Returns the name of the analyser which will be run.
.SS \fBdlf_analyser_config()\fP
.IX Subsection "dlf_analyser_config()"
Returns the analysis configuration data that should be used by the
converter.
.SS \fBdlf_count()\fP
.IX Subsection "dlf_count()"
Returns the number of DLF records created.
.SS \fBerror_count()\fP
.IX Subsection "error_count()"
Returns the number of errors encountered in the conversion process.
.SS \fBsource_filter()\fP
.IX Subsection "source_filter()"
Returns a Lire::FilterExpr which should be used to limit the DLF
records to analyse.
.PP
This method returns null if the whole DLF stream should be analysed.
.SH "API FOR THE DLF ANALYSERS"
.IX Header "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.
.ie n .SS "write_dlf(  $dlf, [$related_to] )"
.el .SS "write_dlf(  \f(CW$dlf\fP, [$related_to] )"
.IX Subsection "write_dlf( $dlf, [$related_to] )"
This writes the \f(CW$dlf\fR DLF record conforming the \f(CW$schema\fR\*(Aqs schema in the
Lire::DlfStore. \f(CW$Dlf\fR is an hash reference. Keys are the schema\*(Aqs field
name. Undefined value means that this field isn\*(Aqt available in that
record.
.PP
When writing to a derived schema, the \f(CW$related_to\fR parameter can be
an arrayr reference containing the dlf_ids of the related record.
.ie n .SS "error( $error_msg );"
.el .SS "error( \f(CW$error_msg\fP );"
.IX Subsection "error( $error_msg );"
Method that should be used by the Lire::Analyser to report that an
error was encountered during the analysis process. \f(CW$error_msg\fR should
be used to report the nature of the error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfStore\fR\|(3pm) \fBLire::DlfAnalyser\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR DlfAnalyserProcess.pm,v 1.10 2006/07/23 13:16:28 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
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.
.PP
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.
.PP
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.