Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

lire::outputformat(3pm) [debian man page]

OutputFormat(3pm)					  LogReport's Lire Documentation					 OutputFormat(3pm)

NAME
Lire::OutputFormat - Base interface for all OutputFormats. SYNOPSIS
use base qw/ Lire::OutputFormat /; DESCRIPTION
The Lire::OutputFormat objects are used to This package defines the interface which is implemented by all the different OutputFormat that Lire is able to produce. It is this object which has the responsability to convert the XML report to its final format. META INFORMATION METHODS
The Lire::OutputFormat interface extends the Lire::Plugin interface, so they must implement all standard meta-information methods (name(), title(), description()). missing_requirements() This method is queried at runtime to determine if any requirements are missing. It should return an array of messages explaining each missing requirements for the format. FORMATTING A REPORT
format_report( $xml_file, $output_file, $format_cfg ) This method should format the XML report contained in $xml_file into the $output_file (or directory). Additional configuration options are passed in the $format_cfg Lire::Config::TypeSpec object specific to the plugin. mime_report( $xml_file, $format_cfg ) WHen this method is invoked it, the plugin should format the report contained in $xml_file and MIME encapsulate it a MIME::Entity object which is return. Formatting options can be be in the $format_cfg Lire::Config::TypeSpec object. SEE ALSO
Lire::ReportJob(3pm) Lire::OutputJob(3pm) AUTHOR
Francis J. Lacoste <flacoste@logreport.org> VERSION
$Id: OutputFormat.pm,v 1.6 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. Lire 2.1.1 2006-07-23 OutputFormat(3pm)

Check Out this Related Man Page

Index(3pm)						  LogReport's Lire Documentation						Index(3pm)

NAME
Lire::Config::Index - Index registry and interface SYNOPSIS
use base qw/Lire::Config::Index/; sub has_entry { my ($self, $name) = @_; ... } sub entries { my $self = $_[0]; ... } sub get_ref { my ($self, $name) = @_; ... } DESCRIPTION
The Lire::Config::Index interface is used by the Lire::Config::ReferenceSpec(3pm) to validate and obtain referenced object. INDEX REGISTRY
These are the class methods used to register and obtain Index objects. has_index( $name ) Returns true if an index was registered under $name. get_index( $name ) Retuurns the Index named $name. Croaks if no such index was registered. set_index( $name, $index ) Registers $index under $name. Replaces any previous index registered under the same name. INDEX INTERFACE
has_entry( $name ) Should return true if $name is defined in this index. entries() Should return all the entries defined in the index. get_ref( $name ) Should return the object indexed under $name. An error should be thrown if there is no such entry.;. SEE ALSO
Lire::Config::Reference(3pm) Lire::Config::ReferenceSpec(3pm) Lire:Config::ReportConfigIndex(3pm) AUTHOR
Francis J. Lacoste <flacoste@logreport.org> VERSION
$Id: Index.pm,v 1.2 2006/07/23 13:16:30 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 Index(3pm)
Man Page

Featured Tech Videos