.\" -*- 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 "DlfCategoriser 3pm"
.TH DlfCategoriser 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::DlfCategoriser \- Base class for analysers which produce extended
DLF records.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::DlfCategoriser /;
\&
\&  sub categorise {
\&    my ( $self, $dlf ) = @_;
\&
\&    # Adds the extended field to DLF.
\&
\&    return;
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
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 \fBcategorise()\fR method instead of the
more generic \fBanalyse()\fR.
.SH "META INFORMATION METHODS"
.IX Header "META INFORMATION METHODS"
The Lire::DlfCategoriser should implement the same meta\-information
methods than the Lire::DlfAnalyser (\fBname()\fR, \fBsrc_schema()\fR,
\&\fBdst_schema()\fR, \fBtitle()\fR, \fBdescription()\fR).
.SH "IMPLEMENTATION METHODS"
.IX Header "IMPLEMENTATION METHODS"
The categoriser does its job using the \fBinitialise()\fR and \fBcategorise()\fR
methods.
.ie n .SS "analyse( $process, $config )"
.el .SS "analyse( \f(CW$process\fP, \f(CW$config\fP )"
.IX Subsection "analyse( $process, $config )"
The Lire::DlfCategoriser implements the \fBanalyse()\fR method. It will
run the query on the \fBsrc_schema()\fR using the correct filter and will
call \fBcategorise()\fR on each DLF returned. The extended fiels will then
be written to \fBdst_schema()\fR. Errors should be reported by dying.
.ie n .SS "initialise( $config )"
.el .SS "initialise( \f(CW$config\fP )"
.IX Subsection "initialise( $config )"
This method is called before the \fBcategorise()\fR method is called.
.PP
The \f(CW$config\fR 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
\&\fIanalyser_name\fR_properties. This should be either a RecordSpec or
ObjectSpec.
.ie n .SS "categorise( $dlf )"
.el .SS "categorise( \f(CW$dlf\fP )"
.IX Subsection "categorise( $dlf )"
Called one for each DLf records that should be categorised. The
categoriser should add the extended fields directly to the \f(CW$dlf\fR hash
reference.
.ie n .SS "finalise( $config )"
.el .SS "finalise( \f(CW$config\fP )"
.IX Subsection "finalise( $config )"
This method is called after all the DLF records were categorised.
.PP
The \f(CW$config\fR 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
\&\fIanalyser_name\fR_properties. This should be either a RecordSpec or
ObjectSpec.
.PP
The default implementation does nothing.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfAnalyserProcess\fR\|(3pm), \fBLire::DlfStore\fR\|(3pm),
\&\fBLire::PluginManager\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 DlfCategoriser.pm,v 1.6 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.