man Lire::Timegroup (3): Base class for implementation of the timegroup aggregator

SYNOPSIS

use Lire::Timegroup;

DESCRIPTION

This module is the base class for implementation of the timegroup aggregator. This aggregator will split the DLF records based on a time period controlled throught the period attribute. For example, using 1d as the period value, this aggregator will group all records in the same day period together.

CONSTRUCTOR

new( %params )

Creates a new instance of a timegroup aggregator. In addition to the normal report operator parameters, the timegroup aggregator can take several parameters:

field: This optional parameter contains the DLF field which contains the time value used to group the DLF records together. See the field() method for more information.
period: This mandatory parameter should contains the period's length that will be used to group the records. See the period() method for more information.

METHODS

field( [$new_field] )

Returns the DLF field's name that is used to group the DLF records. This should be a valid timestamp DLF field in the current schema. By default, the default timestamp field of the DLF schema is used.

You can change the field by passing a $new_field parameter.

period( [$new_period])

Returns the period's length in which the records are grouped. This can either be a duration value or the name of a report specification's parameter containing a duration value.

The period's length can be changed by using the $new_period parameter.

AUTHORS

  Francis J. Lacoste <[email protected]>
  Wolfgang Sourdeau <[email protected]>

VERSION

$Id: Timegroup.pm,v 1.33 2006/07/23 13:16:30 vanbaal Exp $

COPYRIGHT

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.