.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Count 3pm"
.TH Count 3pm 2024-07-12 "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::Count \- Lire class that implements the count operator
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Lire::Count
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class that implements the count operator. This operator counts the
number of DLF records in the current group.
.PP
If the fields attribute is set, the count statistics will be equals to
the number of different values present in the fields specified by that
attribute.
.PP
Its also possible to express the count as a ratio of the total count
for the group or table.
.SH METHODS
.IX Header "METHODS"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new Lire::Count object. In addition to the values
supported by its parents, the fields and ratio attributes will be
initialized to the values specified in the \f(CW%params\fR argument.
.SS "fields( [$new_fields] )"
.IX Subsection "fields( [$new_fields] )"
Returns the fields for which we are counting the different values.
This a reference to an array of DLF field names.
.PP
If the \f(CW$new_fields\fR parameter is set, it will be used as the new
\&\f(CW$fields\fR value. It must be an array reference and should only contains
valid field names for the current report specification's schema.
.SS ratio([$new_ratio])
.IX Subsection "ratio([$new_ratio])"
Returns how the count will be expressed. This can one of three
possible values:
.IP none 4
.IX Item "none"
Default. The absolute count will be used.
.IP group 4
.IX Item "group"
The count will be expressed as a percentage of the group's count.
.IP table 4
.IX Item "table"
The count will be expressed as a percentage of the table's total
count.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportSpec\fR\|(3pm), \fBLire::ReportOperator\fR\|(3pm), \fBLire::Aggregator\fR\|(3pm), \fBLire::Aggregate\fR\|(3pm).
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Count.pm,v 1.16 2008/03/09 19:27:31 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001, 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 GNU 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 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.
.PP
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.