.\" 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 "Subreport 3pm"
.TH Subreport 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::Subreport \- Interface to a Lire subreport.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Lire::ReportParser::ReportBuilder;
\&    my $parser = new Lire::ReportParser::ReportBuilder;
\&    my $report = $parser\->parse( "report.xml" );
\&
\&    foreach my $s ( $report\->sections() ) {
\&        print "Section: \*(Aq", $s\->title(), "\en\en";
\&        foreach my $r ( $s\->subreports() ) {
\&            print "Subreport ", $r\->title(), " has ", scalar $r\->entries(),
\&                " entries\en";
\&        }
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module offers an \s-1API\s0 to the subreports included in the sections
of a Lire's report.
.PP
This object has all the methods that the \fILire::Report::Group\fR\|(3pm)
object offers. You'll find more information on to access the data
contained in a subreport in that man page.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.ie n .SS "new( $superservice, $type)"
.el .SS "new( \f(CW$superservice\fP, \f(CW$type\fP)"
.IX Subsection "new( $superservice, $type)"
Creates a new Lire::Report::Subreport object. The \f(CW$superservice\fR
parameter and \f(CW$type\fR parameters defines the report specification which
was used to generate this subreport's data.
.ie n .SS "new_missing( $superservice, $type, [$reason])"
.el .SS "new_missing( \f(CW$superservice\fP, \f(CW$type\fP, [$reason])"
.IX Subsection "new_missing( $superservice, $type, [$reason])"
Creates a new Lire::Report::Subreport object marked as missing. The
\&\f(CW$superservice\fR parameter and \f(CW$type\fR parameters defines the report
specification which was used to generate this subreport's data. The
\&\f(CW$reason\fR parameter sets the reason why this subreport is missing.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.ie n .SS "id( [ $new_id ] )"
.el .SS "id( [ \f(CW$new_id\fP ] )"
.IX Subsection "id( [ $new_id ] )"
Returns (and optionnally change) the id of this subreport. The
subreport's \s-1ID\s0 uniquely identify it in its Report. Subreports with the
same \s-1ID\s0 will be merged together.
.SS "\fIis_missing()\fP"
.IX Subsection "is_missing()"
Returns true if this subreport was marked as missing in the \s-1XML\s0 file.
A missing subreport is a subreport which was present in the report
configure file but which was marked as missing in the \s-1XML\s0 report. This
happens when the report specification requires fields that weren't
available in the \s-1DLF\s0 files generated. It can also happen when an error
occurs in the report generation process.
.SS "\fImissing_reason()\fP"
.IX Subsection "missing_reason()"
Reports why the subreport is missing. This will be undefined when the
subreport is not missing.
.SS "\fIsuperservice()\fP"
.IX Subsection "superservice()"
Returns the superservice of this subreport. This is the superservice
that defined the report specification from which the subreport was
generated.
.SS "\fItype()\fP"
.IX Subsection "type()"
Returns the type of this subreport. This is the \s-1ID\s0 of the report specification that was used to generate this subreport.
.ie n .SS "schemas( [ $schema, ... ] )"
.el .SS "schemas( [ \f(CW$schema\fP, ... ] )"
.IX Subsection "schemas( [ $schema, ... ] )"
Returns the schemas used by this Subreport.
.ie n .SS "field_schema( $field )"
.el .SS "field_schema( \f(CW$field\fP )"
.IX Subsection "field_schema( $field )"
Returns the schema which contain field \f(CW$field\fR. Returns undef if this
name isn't defined in any schema.
.SS "\fIchart_configs()\fP"
.IX Subsection "chart_configs()"
Returns an array reference containing Lire::Report::ChartConfig
objects specifying the charts that should be generated from this
Subreport.
.ie n .SS "add_chart_config( $chart_config )"
.el .SS "add_chart_config( \f(CW$chart_config\fP )"
.IX Subsection "add_chart_config( $chart_config )"
Adds a Lire::Report::ChartConfig object specifying a chart that 
should be generated from this Subreport's data.
.SS "title( [$title] )"
.IX Subsection "title( [$title] )"
Returns the subreport's title.
.PP
If the \f(CW$title\fR is parameter is set, the subreport's title will be set to
this new value.
.SS "description( [$new_desc] )"
.IX Subsection "description( [$new_desc] )"
Returns this subreport's description. The description is encoded in
DocBook \s-1XML\s0.
.PP
If the \f(CW$description\fR parameter is set, this method will set this
subreport's description to this new value. If the \f(CW$description\fR
parameter is undef, that description will be removed.
.SS "table_info( [$table_info] )"
.IX Subsection "table_info( [$table_info] )"
Returns the top-level Lire::Report::TableInfo object describing this
table layout. If \f(CW$table_info\fR parameter is set, the subreport table
info will be set to this object.
.SS "\fInrows()\fP"
.IX Subsection "nrows()"
Returns the number of rows in the table.
.SS "\fIlast_row_idx()\fP"
.IX Subsection "last_row_idx()"
Returns the index of the last row of data.
.ie n .SS "getrow_by_idx( $index )"
.el .SS "getrow_by_idx( \f(CW$index\fP )"
.IX Subsection "getrow_by_idx( $index )"
Returns an array reference containing row 'idx' of the subreport data.
A row will contain all the values (categorical and numerical) that
would appear on the same row. When an entry is made of categorical
variables plus nested groups, the group's summary values will appear
on the same row than the categorical variable.
.PP
Each value is the hash reference that is returned by
\&\fIEntry::data_by_name()\fR for that column and it is in the row at the
column's index.
.SS "\fIgetrows()\fP"
.IX Subsection "getrows()"
Returns all rows contained in the subreport. This method is useful for
rendering the subreport table.
.SS "\fIfinalize()\fP"
.IX Subsection "finalize()"
This method should be called after all entries were added. It assign
row-idx and computes column width and statistics.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::ReportParser::ReportBuilder\fR\|(3pm) \fILire::Report::Section\fR\|(3pm)
\&\fILire::Report::Report\fR\|(3pm) \fILire::Report::Entry\fR\|(3pm),
\&\fILire::Report::Group\fR\|(3pm), \fILire::Report::ChartConfig\fR\|(3pm)
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR Subreport.pm,v 1.46 2006/07/23 13:16:31 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.
.SH "AUTHOR"
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 206:" 4
.IX Item "Around line 206:"
=cut found outside a pod block.  Skipping to next block.