.\" 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 "ColumnInfo 3pm" .TH ColumnInfo 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::ColumnInfo \- Object that holds column meta\-data. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& my $info = $subreport\->column_info_by_idx( 0 ); \& print "Column\*(Aqs name: ", $info\->name(), "\en"; \& print "Column\*(Aqs index: ", $info\->index(), "\en"; \& print "Column\*(Aqs type: ", $info\->type(), "\en"; \& print "Column\*(Aqs label: ", $info\->label(), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Lire::Report::ColumnInfo object contains meta-data information on the columns of a subreport. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .ie n .SS "new( $group, $name, $class, $type, [$label]])" .el .SS "new( \f(CW$group\fP, \f(CW$name\fP, \f(CW$class\fP, \f(CW$type\fP, [$label]])" .IX Subsection "new( $group, $name, $class, $type, [$label]])" Creates a new Lire::Report::ColumnInfo object. The column info attributes are initialized based on \f(CW$name\fR, \f(CW$class\fR, \f(CW$type\fR and \f(CW$label\fR. .SH "OBJECT METHODS" .IX Header "OBJECT METHODS" .SS "\fIname()\fP" .IX Subsection "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. .SS "\fIclass()\fP" .IX Subsection "class()" Returns the column's class of data. This will be either 'numerical' or \&'categorical'. .SS "\fItype()\fP" .IX Subsection "type()" Returns the column's type. This referes to the type of the \s-1DLF\s0 field that was usd to generate this column's values. .SS "\fIgroup_info()\fP" .IX Subsection "group_info()" Returns the GroupInfo object which contains this column. .SS "\fIindex()\fP" .IX Subsection "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. .SS "\fIcol_start()\fP" .IX Subsection "col_start()" Returns the display column which is the start of the cell span that should be used to render this column's values. .SS "\fIcol_end()\fP" .IX Subsection "col_end()" Returns the display column which is the end of the cell span that should be used to render this column's values. .SS "\fIcol_width()\fP" .IX Subsection "col_width()" Returns the suggested column width for this column in characters. .SS "\fImax_chars()\fP" .IX Subsection "max_chars()" This method returns the length of the longest string in that column (including the label). .SS "\fIavg_chars()\fP" .IX Subsection "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). .SS "label( [$label] )" .IX Subsection "label( [$label] )" Returns the column's label. If the \f(CW$label\fR parameter is defined, the column's label will be set to this new value. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fILire::Report::Subreport\fR\|(3pm) \fILire::Report::GroupInfo\fR\|(3pm) .SH "VERSION" .IX Header "VERSION" \&\f(CW$Id:\fR ColumnInfo.pm,v 1.15 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