NAME

       Lire::Count - Lire class that implements the count operator

SYNOPSIS

        use Lire::Count

DESCRIPTION

       Class that implements the count operator. This operator counts the number of DLF records
       in the current group.

       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.

       Its also possible to express the count as a ratio of the total count for the group or
       table.

METHODS

   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 %params
       argument.

   fields( [$new_fields] )
       Returns the fields for which we are counting the different values.  This a reference to an
       array of DLF field names.

       If the $new_fields parameter is set, it will be used as the new $fields value. It must be
       an array reference and should only contains valid field names for the current report
       specification's schema.

   ratio([$new_ratio])
       Returns how the count will be expressed. This can one of three possible values:

       none
           Default. The absolute count will be used.

       group
           The count will be expressed as a percentage of the group's count.

       table
           The count will be expressed as a percentage of the table's total count.

SEE ALSO

       Lire::ReportSpec(3pm), Lire::ReportOperator(3pm), Lire::Aggregator(3pm),
       Lire::Aggregate(3pm).

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: Count.pm,v 1.16 2008/03/09 19:27:31 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2001, 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.