lire::plugin(3pm) [debian man page]
Plugin(3pm) LogReport's Lire Documentation Plugin(3pm) NAME
Lire::Plugin - Base interface of all Lire plugins. SYNOPSIS
use base qw/ Lire::Plugin /; DESCRIPTION
This package defines the base interface implemented by all plugins. DEFAULT CONSTRUCTOR
The plugin class has new() constructor which blesses an hash reference. name() Returns the name of the plugin. title() Returns a more human friendly name for the plugin. description() Returns a DocBook XML based documentation of the plugin. type Returns the type of plugin. There are three plugin types in Lire: dlf_converter These plugins are used to converter log files to DLF. Plugin will also need to implement the Lire::DlfConverter interface. output_format These plugins are used to format XML reports. Plugin of this type should implement the Lire::OutputFormat interface. dlf_analyser These plugins are used to generate other DLF records from existing Dlf records. They should implement the Lire::Analaser interface. chart_type These plugins are used to generate charts. SEE ALSO
Lire::PluginManager(3pm), Lire::DlfConverter(3pm), Lire::OutputFormat(3pm), Lire::DlfAnalyser(3pm), Lire::DlfChartType(3pm) AUTHOR
Francis J. Lacoste <flacoste@logreport.org> VERSION
$Id: Plugin.pm,v 1.5 2006/07/23 13:16:29 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. POD ERRORS
Hey! The above document had some coding errors, which are explained below: Around line 108: You forgot a '=back' before '=head1' Lire 2.1.1 2006-07-23 Plugin(3pm)
Check Out this Related Man Page
DlfAnalyser(3pm) LogReport's Lire Documentation DlfAnalyser(3pm) 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. Lire 2.1.1 2006-07-23 DlfAnalyser(3pm)