.\" -*- 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 "DlfAnalyser 3pm"
.TH DlfAnalyser 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::DlfAnalyser \- Base interface for all DLF analysers.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::DlfAnalyser /;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package defines the interface that must be implemented by all DLF
Analysers. All the methods defined in this package will throw a
\&\*(Aqmethod not implemented\*(Aq exception if they are called.
.PP
Analyser which produce DLF records for an extended schema should
probably use the simpler Lire::DlfCategoriser interface.
.SH "META INFORMATION METHODS"
.IX Header "META INFORMATION METHODS"
These methods provides information to the Lire framework about the DLF
analysers.
.PP
The Lire::DlfAnalyser interface extends the Lire::Plugin interface, so
they must implement all standard meta\-information methods (\fBname()\fR,
\&\fBtitle()\fR, \fBdescription()\fR).
.SS \fBsrc_schema()\fP
.IX Subsection "src_schema()"
Returns the Dlf schema which is analysed by this analyser.
.PP
E.g. \f(CW\*(C`www\*(C'\fR
.SS \fBdst_schema()\fP
.IX Subsection "dst_schema()"
Returns the Dlf schema which is producted by this analyser.
.PP
E.g. \f(CW\*(C`www\-user_session\*(C'\fR
.SH "IMPLEMENTATION METHOD"
.IX Header "IMPLEMENTATION METHOD"
The analyser does its job using the \fBanalyse()\fR method.
.ie n .SS "analyse( $process, $config )"
.el .SS "analyse( \f(CW$process\fP, \f(CW$config\fP )"
.IX Subsection "analyse( $process, $config )"
The \f(CW$process\fR parameter contains the Lire::DlfAnalyserProcess object
which is controlling the conversion process.
.PP
The \f(CW$config\fR parameter contains configuration data that was specified
in the AnalysisJob for that converter. To register configuration
specification for you DlfAnalyser, you just need to define a
configuration specification under the name
\&\fIanalyser_name\fR_properties. This should be either a RecordSpec or
ObjectSpec.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfAnalyserProcess\fR\|(3pm), \fBLire::DlfStore\fR\|(3pm),
\&\fBLire::PluginManager\fR\|(3pm), \fBLire::DlfCategoriser\fR\|(3pm).
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR DlfAnalyser.pm,v 1.4 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.