.\" -*- 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 "ReportConfig 3pm"
.TH ReportConfig 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::ReportConfig \- API to the report configuration file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::ReportConfig;
\&
\&    my $templates = Lire::ReportConfig\->templates();
\&    if ( Lire::ReportConfig\->has_template( \*(Aqwww_default\*(Aq ) ) {
\&        my $report_cfg = Lire::ReportConfig\->template( \*(Aqwww_default\*(Aq )\->as_value();
\&        my $report = $report_cfg\->generate_report( $report );
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents report configurations. Report configurations are
stored as an XML configuration using the Lire::Report::ReportSpec
configuration type.
.SH TEMPLATES
.IX Header "TEMPLATES"
Template reports are configuration specification files found in the
directories specified by the \*(Aqlr_templates_path\*(Aq configuration
variable.
.SS \fBtemplates()\fP
.IX Subsection "templates()"
Returns an array reference containing the names of all defined
templates.
.ie n .SS "has_template( $name )"
.el .SS "has_template( \f(CW$name\fP )"
.IX Subsection "has_template( $name )"
Returns true if there is a template named \f(CW$name\fR available.
.ie n .SS "template( $name )"
.el .SS "template( \f(CW$name\fP )"
.IX Subsection "template( $name )"
Returns a Lire::Config::Object defining the template ReportConfig
named \f(CW$name\fR. Its \fBspec()\fR method would return a Lire::Config::ReportSpec
object and its \fBas_value()\fR method would instantiate a
Lire::ReportConfig object.
.SH CONSTRUCTORS
.IX Header "CONSTRUCTORS"
.SS \fBnew()\fP
.IX Subsection "new()"
This creates a new empty Lire::ReportConfig object.
.PP
The created report configuration object doesn\*(Aqt contain any section,
report or filter specifications.
.ie n .SS "new_from_file( $superservice, $report_cfg )"
.el .SS "new_from_file( \f(CW$superservice\fP, \f(CW$report_cfg\fP )"
.IX Subsection "new_from_file( $superservice, $report_cfg )"
This will create a new report configuration object for the
\&\f(CW$superservice\fR superservice based on the report configuration file
\&\f(CW$report_cfg\fR.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.ie n .SS "filename( [ $new_filename ] )"
.el .SS "filename( [ \f(CW$new_filename\fP ] )"
.IX Subsection "filename( [ $new_filename ] )"
Returns (and optionanly changes) the filename from which this
ReportConfig was loaded. It will return undef if the ReportConfig
wasn\*(Aqt loaded from a file.
.ie n .SS "title( [ $new_title ] )"
.el .SS "title( [ \f(CW$new_title\fP ] )"
.IX Subsection "title( [ $new_title ] )"
Returns (and optionnally changes) the title that will be assigned to
the report.
.SS \fBschemas()\fP
.IX Subsection "schemas()"
Returns an array reference containing the name of the schemas used
in this report.
.SS \fBsections()\fP
.IX Subsection "sections()"
Return\*(Aqs this report configuration\*(Aqs sections as an array of
Lire::Section objects.
.ie n .SS "add_section( $section )"
.el .SS "add_section( \f(CW$section\fP )"
.IX Subsection "add_section( $section )"
Adds a section to this report configuration. The \f(CW$section\fR parameter
should be a Lire::ReportSection object.
.SS \fBmerge_filters()\fP
.IX Subsection "merge_filters()"
Calling this method will make sure that all report specifications
take into account their section\*(Aqs filter specification.
.PP
This method will modify all report specifications. After this their
object representation won\*(Aqt be identical to the one in the XML report
specification.
.SS "print( [$fh] )"
.IX Subsection "print( [$fh] )"
Prints the report configuration on the \f(CW$fh\fR filehandle. If the \f(CW$fh\fR
parameter is omitted, the report configuration will be printed on
STDOUT.
.ie n .SS "create_report( $timespan_start, $timespan_end )"
.el .SS "create_report( \f(CW$timespan_start\fP, \f(CW$timespan_end\fP )"
.IX Subsection "create_report( $timespan_start, $timespan_end )"
Returns a Lire::Report object based on this report\*(Aqs configuration file.
The \f(CW$timespan_start\fR and \f(CW$timespan_end\fR attribute will be used to initiate
the Report object.
.PP
Used when generating an XML report from a DLF source, and
when merging XML reports.
.PP
The real job is delegated to \fBLire::ReportSection::create_report_section()\fR.
.ie n .SS "create_analyser_streams( $store )"
.el .SS "create_analyser_streams( \f(CW$store\fP )"
.IX Subsection "create_analyser_streams( $store )"
This method will make sure that a DlfStream is available in the
Lire::DlfStore \f(CW$store\fR for each schema used by this report
configuration. The stream will be created by running the first
analyser which is able to generate the schema using exising streams.
.ie n .SS "generate_report( $store )"
.el .SS "generate_report( \f(CW$store\fP )"
.IX Subsection "generate_report( $store )"
Generates a Lire::Report from this report configuration. The report is
computed using the streams in the Lire::DlfStore \f(CW$store\fR.
.ie n .SS "merge_report_files( @report_files )"
.el .SS "merge_report_files( \f(CW@report_files\fP )"
.IX Subsection "merge_report_files( @report_files )"
Generate a new Lire::Report based on this report configuration by
merging XML reports. Every report spec contained in the configuration
will be the result of the merging of all the subreports having the
same id.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportSection\fR\|(3pm), \fBLire::ReportSpec\fR\|(3pm),
\&\fBLire::FilterSpec\fR\|(3pm) \fBLire::Report\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR ReportConfig.pm,v 1.38 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002, 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.