.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DlfAnalyserProcess 3pm"
.TH DlfAnalyserProcess 3pm "2020-07-07" "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 \s-1DLF\s0 analysis process. It takes as a
Lire::DlfStore, the name of the analyser, its configuration and
optionally, a dlf_source \s-1ID.\s0 When a dlf_source is used, the analysis
will only be done using the \s-1DLF\s0 coming from that source.
.PP
The object provides the \s-1API\s0 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 \s-1DLF.\s0 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 \s-1DLF\s0 records.
.SS "\fBdlf_source()\fP"
.IX Subsection "dlf_source()"
Returns the source from which the \s-1DLF\s0 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 \s-1DLF\s0 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 \s-1DLF\s0
records to analyse.
.PP
This method returns null if the whole \s-1DLF\s0 stream should be analysed.
.SH "API FOR THE DLF ANALYSERS"
.IX Header "API FOR THE DLF ANALYSERS"
This is the object that encapsulates the \s-1DLF\s0 implementation and hides
the complexitity of the storage framework from the \s-1DLF\s0 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 \s-1DLF\s0 record conforming the \f(CW$schema\fR's schema in the
Lire::DlfStore. \f(CW$Dlf\fR is an hash reference. Keys are the schema's field
name. Undefined value means that this field isn't 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 \s-1GNU\s0 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 \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.