Provided by: lire-devel-doc_2.1-1.1_all bug

NAME

       Lire::DlfAnalyser - Base interface for all DLF analysers.

SYNOPSIS

         use base qw/ Lire::DlfAnalyser /;

DESCRIPTION

       This package defines the interface that must be implemented by all DLF Analysers. All the
       methods defined in this package will throw a 'method not implemented' exception if they
       are called.

       Analyser which produce DLF records for an extended schema should probably use the simpler
       Lire::DlfCategoriser interface.

META INFORMATION METHODS

       These methods provides information to the Lire framework about the DLF analysers.

       The Lire::DlfAnalyser interface extends the Lire::Plugin interface, so they must implement
       all standard meta-information methods (name(), title(), description()).

   src_schema()
       Returns the Dlf schema which is analysed by this analyser.

       E.g. "www"

   dst_schema()
       Returns the Dlf schema which is producted by this analyser.

       E.g. "www-user_session"

IMPLEMENTATION METHOD

       The analyser does its job using the analyse() method.

   analyse( $process, $config )
       The $process parameter contains the Lire::DlfAnalyserProcess object which is controlling
       the conversion process.

       The $config 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 analyser_name_properties. This
       should be either a RecordSpec or ObjectSpec.

SEE ALSO

       Lire::DlfAnalyserProcess(3pm), Lire::DlfStore(3pm), Lire::PluginManager(3pm),
       Lire::DlfCategoriser(3pm).

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: DlfAnalyser.pm,v 1.4 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.