.\" 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 "TableInfo 3pm" .TH TableInfo 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::TableInfo \- Object that holds all the GroupInfo and ColumnInfo for one subreport .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& my $info = $subreport\->table_info; \& my $col_info = $info\->colum_info( "request_total" ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Lire::Report::TableInfo object holds the ColumnInfo and GroupInfo objects for one subreport.. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "\fInew()\fP" .IX Subsection "new()" Creates a new Lire::Report::TableInfo object. .ie n .SS "column_info_by_name( $name )" .el .SS "column_info_by_name( \f(CW$name\fP )" .IX Subsection "column_info_by_name( $name )" Returns the Lire::Report::ColumnInfo object that has the name \f(CW$name\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if there is no column named \f(CW$name\fR. .ie n .SS "column_info_by_col_start( $idx )" .el .SS "column_info_by_col_start( \f(CW$idx\fP )" .IX Subsection "column_info_by_col_start( $idx )" Returns the Lire::Report::ColumnInfo object that is starts at column index \f(CW$idx\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if this column is out of bounds. .ie n .SS "group_info( $name )" .el .SS "group_info( \f(CW$name\fP )" .IX Subsection "group_info( $name )" Returns the Lire::Report::GroupInfo object that has the name \f(CW$name\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if there is no column named \f(CW$name\fR. .SS "\fIncols()\fP" .IX Subsection "ncols()" Returns the number of columns there is in this table. .SS "\fIcolumn_infos()\fP" .IX Subsection "column_infos()" Returns an array containing all the columns of the table. Each element is a Lire::Report::ColumnInfo object. .SS "\fIgroups()\fP" .IX Subsection "groups()" Returns an array containing all the groups of the table. Each element is a Lire::Report::GroupInfo object. .SS "\fIcolumns_width()\fP" .IX Subsection "columns_width()" Returns an array where each element represents the suggested columns' width in characters. .SS "\fIheader_rows()\fP" .IX Subsection "header_rows()" Returns an array reference containing one array reference for each rows in the header. Each row contains the ColumnInfo that should appear on the header line. The first row contains all the numerical columns and the categorical columns appear based on their nesting. The indices of the column is always equals to its column's start. .SS "\fIset_variables_indices()\fP" .IX Subsection "set_variables_indices()" Registers this TableInfo's variables using Lire::Config::VariableIndex. .SS "\fIreset_variable_indices()\fP" .IX Subsection "reset_variable_indices()" Removes the variables indices. This can be called to undo the effect of \fIset_variables_indices()\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fILire::Report::Subreport\fR\|(3pm) \fILire::Report::ColumnInfo\fR\|(3pm) .SH "VERSION" .IX Header "VERSION" \&\f(CW$Id:\fR TableInfo.pm,v 1.26 2006/07/23 13:16:31 vanbaal Exp $ .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2002 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