.\" 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 "Entry 3pm"
.TH Entry 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::Entry \- Interface to subreport's data.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    foreach my $name ( $entry\->names() ) {
\&        print "Name: ", $name\->{\*(Aqcontent\*(Aq}, "\en";
\&    }
\&
\&    foreach my $value ( $entry\->values() ) {
\&        if ( ref $value eq \*(AqLire::Report::Group\*(Aq ) {
\&            # Value is a group
\&            foreach my $e ( $value\->entries() ) {
\&                print_entry( $e );
\&            }
\&        } else {
\&            print "Value: ", $value\->{\*(Aqcontent\*(Aq}, "\en";
\&        }
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Lire::Report::Entry objects are used to hold the subreport's data.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
One creates a new Entry object by using the create_entry method on a
Lire::Report::Subreport or Lire::Report::Group object.  Use the \fIadd_name()\fR,
\&\fIcreate_group()\fR and \fIadd_value()\fR methods to fill the entry.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.SS "\fIrow_idx()\fP"
.IX Subsection "row_idx()"
Returns the row index in the table body where this entry's data should
be displayed. If undef, this entry shouldn't be displayed.
.SS "\fIsubreport()\fP"
.IX Subsection "subreport()"
Returns the Lire::Report::Subreport object in which this entry is contained.
.SS "\fIgroup()\fP"
.IX Subsection "group()"
Returns the Lire::Report::Group object which contains this entry.
.SS "\fIgroup_info()\fP"
.IX Subsection "group_info()"
Returns the Lire::Report::GroupInfo which contains the information
related to the group in which this entry is.
.SS "\fIdata()\fP"
.IX Subsection "data()"
Returns as an array the data contained in this entry. This is a list
of hashes or Lire::Report::Group object.
.ie n .SS "data_by_name( $name )"
.el .SS "data_by_name( \f(CW$name\fP )"
.IX Subsection "data_by_name( $name )"
Returns the data item contained in this Entry that was generated by
the operator named \f(CW$name\fR. Returns undef if no such data item can be
found.
.SS "\fInames()\fP"
.IX Subsection "names()"
Returns the names of the entry. This is an array of hashes. The name's
hash contains the following keys:
.IP "type" 4
.IX Item "type"
Always set to 'name'.
.IP "content" 4
.IX Item "content"
That's the actual content of the name element. This contains the name
in a format suitable for display.
.IP "value" 4
.IX Item "value"
This contains the unformatted value of the name. For example, when the
name is a time string, this attribute will contains the time in
seconds since epoch.
.IP "missing_cases" 4
.IX Item "missing_cases"
This value contains the number of \s-1DLF\s0 records which had a undefined
value in one of the required fields to compute this statistic.
.IP "range" 4
.IX Item "range"
For some names, the actual content express a range (time, size, etc.).
This attribute contains the length of the range.
.IP "col_info" 4
.IX Item "col_info"
The Lire::Report::ColumnInfo object describing this name.
.ie n .SS "add_name( $content, [$value], [$range] )"
.el .SS "add_name( \f(CW$content\fP, [$value], [$range] )"
.IX Subsection "add_name( $content, [$value], [$range] )"
Adds a new name to this entry. Consult the documentation of the
\&\fInames()\fR method for a description of the meaning of the various
parameters which have the same meaning as the keys with the same
name.
.PP
The names, values and groups should be added in the order specified by
this entry's GroupInfo. You'll get an exception otherwise.
.SS "\fIvalues()\fP"
.IX Subsection "values()"
Returns the values of the entry. This is an array of hashes or objects.
If the value is an hash, it has the following keys:
.IP "type" 4
.IX Item "type"
Always set to 'value'.
.IP "content" 4
.IX Item "content"
That's the actual content of the value element. This contains the
value in a format suitable for display.
.IP "value" 4
.IX Item "value"
This contains the unformatted value. For example, when bytes are
displayed using \*(L"1M\*(R" or \*(L"1.1G\*(R", this will contain the value in single bytes.
.IP "missing_cases" 4
.IX Item "missing_cases"
The number of \s-1DLF\s0 records which had an undefined value in one of
fields required by this operator.
.IP "total" 4
.IX Item "total"
This is used by values that represent an average. It contains the
total which makes up the average.
.IP "n" 4
.IX Item "n"
This is used by values that represent an average. It contains the
total which was used in the division to compute the average.
.IP "col_info" 4
.IX Item "col_info"
The Lire::Report::ColumnInfo object describing this value.
.SS "\fIgroups()\fP"
.IX Subsection "groups()"
Returns in an array the Lire::Report::Group contained in this Entry.
.SS "\fIcreate_group()\fP"
.IX Subsection "create_group()"
Creates a new group for this entry. This will also append it
to this entry data. If you create the group out of order compared to
the names and values that should go in that entry, you'll get an
exception.
.ie n .SS "add_value( %value )"
.el .SS "add_value( \f(CW%value\fP )"
.IX Subsection "add_value( %value )"
Adds a new value to this entry. The value hash should at least
contains the 'content' key. It can also includes values for the 'n',
\&'total' and 'missing_cases' keys. Consult the documentation of the
\&\fIvalues()\fR method for a description of the meaning of the various
parameters: these have the same meaning as the keys with the same
names.
.PP
The names, values and groups should be added in the order specified by
this entry's GroupInfo. You'll get an exception otherwise.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::ReportParser::ReportBuilder\fR\|(3pm) \fILire::Report\fR\|(3pm)
\&\fILire::Report::Subreport\fR\|(3pm) \fILire::Report::Section\fR\|(3pm)
\&\fILire::Report::Group\fR\|(3pm)
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR Entry.pm,v 1.32 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 <flacoste@logreport.org>