lire::report::columninfo(3pm) [debian man page]
ColumnInfo(3pm) LogReport's Lire Documentation ColumnInfo(3pm) NAME
Lire::Report::ColumnInfo - Object that holds column meta-data. SYNOPSIS
my $info = $subreport->column_info_by_idx( 0 ); print "Column's name: ", $info->name(), " "; print "Column's index: ", $info->index(), " "; print "Column's type: ", $info->type(), " "; print "Column's label: ", $info->label(), " "; DESCRIPTION
The Lire::Report::ColumnInfo object contains meta-data information on the columns of a subreport. CONSTRUCTOR
new( $group, $name, $class, $type, [$label]]) Creates a new Lire::Report::ColumnInfo object. The column info attributes are initialized based on $name, $class, $type and $label. OBJECT METHODS
name() Returns the name of this column. This name can be used to find the group operation (from the report specification) that is responsible for the column's content. class() Returns the column's class of data. This will be either 'numerical' or 'categorical'. type() Returns the column's type. This referes to the type of the DLF field that was usd to generate this column's values. group_info() Returns the GroupInfo object which contains this column. index() Returns the column's index in the table. This will be undef until the column info object is added to a Lire::Subreport or Lire::Group object. col_start() Returns the display column which is the start of the cell span that should be used to render this column's values. col_end() Returns the display column which is the end of the cell span that should be used to render this column's values. col_width() Returns the suggested column width for this column in characters. max_chars() This method returns the length of the longest string in that column (including the label). avg_chars() This method returns the average length of strings in that column (including the label). This will be round up to the next integer (1.3 -> 2). label( [$label] ) Returns the column's label. If the $label parameter is defined, the column's label will be set to this new value. SEE ALSO
Lire::Report::Subreport(3pm) Lire::Report::GroupInfo(3pm) VERSION
$Id: ColumnInfo.pm,v 1.15 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> Lire 2.1.1 2006-07-23 ColumnInfo(3pm)
Check Out this Related Man Page
ReportSpec(3pm) LogReport's Lire Documentation ReportSpec(3pm) NAME
Lire::ReportSpec - API to the XML report specifications. SYNOPSIS
use Lire::ReportSpec; DESCRIPTION
META INFORMATION METHODS
list_specs( $superservice ) Returns an array reference containing all the report specification type available for the $superservice superservice. has_spec( $superservice, $type ) Returns true if there is a $type specification available for the $superservice. OBJECT METHODS
subreport_id( [ $new_subreport_id ] ) Returns (and optionnally change) the id that will be associated to the Subreport that will be generated by this specification. chart_configs() Returns an array reference containing the Lire::Report::ChartConfig objects that specifies the charts that should be generated when the Lire::Report::Subrpeport object specified by this object will be formatted. add_chart_config( $chart_config ) Adds a Lire::Report::ChartConfig object that should be added to the Lire::Report::Subreport object that is specified by this object. filter_spec( [ $new_filter_spec ] ) Returns (and optionally changes) the Lire::FilterExpr that should be applied to create the Lire::Report::Subreport specified by this object. This will be undef if no filtering should be applied. calc_spec( [ $new_aggregator ] ) Returns (and optionally changes) the Lire::Aggregator that should be used to create the Lire::Report::Subreport specified by this object. mark_missing( $reason ) Mark that the report that should be generated by this report specification should be marked as missing. The $reason parameter gives the reason why the subreport will be missing. is_missing() Returns true if the subreport generated by this report specification should be marked missing. set_store( $store ) Sets the DLF store upon which this ReportSpec will be generated when create_subreport() will be called. create_subreport() Creates a Lire::Report::Subreport object based on this report specification. This will be a missing subreport if the mark_missing() method was called. Called by Lire::ReportSection::create_report_section(). create_table_info() Returns a Lire::Report::TableInfo object that describes the table generated by subreport of this type. SEE ALSO
Lire::FilterSpec(3pm), Lire::ReportConfig(3pm), Lire::ReportSection(3pm) AUTHOR
Francis J. Lacoste <flacoste@logreport.org> VERSION
$Id: ReportSpec.pm,v 1.59 2006/07/23 13:16:30 vanbaal Exp $ COPYRIGHT
Copyright (C) 2001-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 ReportSpec(3pm)