NAME¶
Lire::Report::Group - Object that include subgroups and other entries.
SYNOPSIS¶
foreach my $e ( $group->entries() ) {
# Process entries' data.
}
DESCRIPTION¶
The Lire::Report::Group object contains entries grouped together in a subreport.
CONSTRUCTOR¶
You create new Lire::Report::Group object by calling the
create_group()
method on one Lire::Report::Entry object.
OBJECT METHODS¶
parent_entry()¶
Returns the entry in which this goup is contained. This will be undef for the
Subreport since it's not contained in any entry.
group_info()¶
Returns the Lire::Report::GroupInfo which contains the information describing
the entries of this group.
subreport()¶
Returns the Lire::Report::Subreport object in which this entry is
row_idx()¶
Returns the row index in the table body where this group's summary should be
displayed. If undef, this group isn't displayed.
show( [$show] )¶
Returns the number of entries that should be displayed in the formatted report.
There may be more entries than that in the group. When this parameter is zero
or undefined, all available entries should be displayed.
If the $show is parameter is set, the group's show parameter will be set to this
new value.
nrecords( [$n] )¶
Returns the number of DLF records that were included in this group.
missing_cases( [$n] )¶
Returns the number of DLF records that contained missing cases which prevent
them from being unclude in the subreport.
summary_values()¶
Returns the summary values of this group. This is an array of hash reference
like the ones returnes by the
values() method described in
Lire::Report::Entry(3pm).
get_summary_value( $name )¶
Returns the summary value of the operator $name. This is an hash reference like
is returned by the
values() method described in
Lire::Report::Entry(3pm). Returns undef if the summary value wasn't
computed for operator $name.
set_summary_value( $name, %value )¶
Sets the value of the operator $name computed over all the DLF records of the
group. Consult the
add_value() method in
Lire::Report::Entry(3pm) for information on the parameters.
entries()¶
Returns the entries in the group.
create_entry()¶
Adds a data entry to this group. This will create a new Lire::Report::Entry
object which can then be filled with data.
find_entry( $name, $dlf )¶
SEE ALSO¶
Lire::ReportParser::ReportBuilder(3pm)
Lire::Report(3pm)
Lire::Report::Subreport(3pm)
Lire::Report::Entry(3pm)
Lire::Report::ChartConfig(3pm)
Lire::Report::Section(3pm)
VERSION¶
$Id: Group.pm,v 1.33 2006/07/23 13:16:31 vanbaal Exp $
COPYRIGHT¶
Copyright (C) 2002 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.
AUTHOR¶
Francis J. Lacoste <flacoste@logreport.org>