.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Report 3pm"
.TH Report 3pm "2006-07-23" "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::Report \- Interface to a Lire report.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Lire::ReportParser::ReportBuilder;
\&    my $parser = new Lire::ReportParser::ReportBuilder;
\&    my $report = $parser\->parse( "report.xml" );
\&
\&    print $report\->superservice(), " report\en";
\&    print "Generated on ", scalar( localtime( $report\->date() ) ), "\en";
\&    print "Timespan starts on ", scalar( localtime( $report\->timespan_start() ) ), "\en";
\&    print "Timespan ends on ", scalar( localtime( $report\->timespan_start() ) ), "\en";
\&    foreach my $s ( $report\->sections() ) {
\&        print "Section: \*(Aq", $s\->title(), "\*(Aq has ", scalar $s\->subreports(),
\&            " subreports in it\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module offers an \s-1API\s0 to the report generated by Lire. The
\&\fILire::ReportParser::ReportBuilder\fR\|(3pm) can be used to create a
Lire::Report object from an \s-1XML\s0 file that complies with the Lire Report
Markup Language \s-1DTD\s0.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
A Lire::Report object can be built from an \s-1XML\s0 report file, from the
\&\fInew()\fR method or from a Lire::ReportConfig object.
.ie n .SS "new( [ $timespan_period ], [ $timespan_start ], [ $timespan_end ] )"
.el .SS "new( [ \f(CW$timespan_period\fP ], [ \f(CW$timespan_start\fP ], [ \f(CW$timespan_end\fP ] )"
.IX Subsection "new( [ $timespan_period ], [ $timespan_start ], [ $timespan_end ] )"
Creates a new Lire::Report. The \f(CW$timespan_period\fR, \f(CW$timespan_start\fR and
\&\f(CW$timespan_end\fR parameters initialize the attributes of the same name.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.SS "\fIversion()\fP"
.IX Subsection "version()"
Returns the version number of the report format which was used in the
external representation of this report. The current version is 2.1.
.SS "generator([$generator)"
.IX Subsection "generator([$generator)"
Returns the generator string that will be outputted in comments when
the \fIwrite_report()\fR method is used. One can change that value by
passing a new value through the \f(CW$generator\fR parameter.
.ie n .SS "date( [ $new_date ] )"
.el .SS "date( [ \f(CW$new_date\fP ] )"
.IX Subsection "date( [ $new_date ] )"
Returns (and optionanly changes) the date in seconds since
epoch on which this report was generated.
.ie n .SS "timespan_period( [ $new_period ] )"
.el .SS "timespan_period( [ \f(CW$new_period\fP ] )"
.IX Subsection "timespan_period( [ $new_period ] )"
Returns (and optionnally changes) the period of the report. The period
can be 'hourly', 'daily', 'weekly', 'monthly' or 'yearly'. When the
period is undef, it is an arbitrary period.
.ie n .SS "timespan_start( [ $new_start ] )"
.el .SS "timespan_start( [ \f(CW$new_start\fP ] )"
.IX Subsection "timespan_start( [ $new_start ] )"
Returns (and optionnally changes) the start of the timespan covered by
this report in seconds since epoch.
.ie n .SS "timespan_end( [ $new_end ] )"
.el .SS "timespan_end( [ \f(CW$new_end\fP ] )"
.IX Subsection "timespan_end( [ $new_end ] )"
Returns (and optionnally changes) the end of the timespan covered by
this report in seconds since epoch.
.SS "title( [$title] )"
.IX Subsection "title( [$title] )"
Returns the report's title, if it has one.
.PP
If the \f(CW$title\fR is parameter is set, the report's title will be set to
this new value.
.SS "description( [$new_desc] )"
.IX Subsection "description( [$new_desc] )"
Returns the report description. This description is encoded in DocBook
\&\s-1XML\s0.
.PP
If the \f(CW$description\fR parameter is set, this method will set the
description to this new value. If the \f(CW$description\fR parameter is undef,
that description will be removed.
.SS "sections( )"
.IX Subsection "sections( )"
Returns the report's sections as an array. This will be an array of
Lire::Report::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. The \f(CW$section\fR parameter should be a
Lire::Report::Section object.
.ie n .SS "subreport_by_id( $id )"
.el .SS "subreport_by_id( \f(CW$id\fP )"
.IX Subsection "subreport_by_id( $id )"
Returns the Lire::Report::Subreport object with \f(CW$id\fR. Returns undef
when there is no subreport with that \s-1ID\s0.
.SS "\fIschemas()\fP"
.IX Subsection "schemas()"
Returns an array reference containing all the schemas used
by this report.
.SS "write_report( [\s-1FH\s0] );"
.IX Subsection "write_report( [FH] );"
Write the report in \s-1XML\s0 format on the \s-1FH\s0 filehandle or \s-1STDOUT\s0 if
omitted.
.PP
This method takes care of adding stuff like the \s-1XML\s0 header \f(CW\*(C`<?xml
version=[...]\*(C'\fR.  It encodes the \s-1XML\s0 report in \s-1UTF\-8\s0, using
\&\fILire::I18N::set_fh_encoding()\fR.
.SS "delete( )"
.IX Subsection "delete( )"
Removes all circular references so that the object can be freed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::ReportParser::ReportBuilder\fR\|(3pm) \fILire::Report::Section\fR\|(3pm)
\&\fILire::Report::Subreport\fR\|(3pm) \fILire::Report::Entry\fR\|(3pm)
\&\fILire::Report::Group\fR\|(3pm)
\&\fILire::ReportParser\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 Report.pm,v 1.35 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 \s-1GNU\s0 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 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.