Lire::Timeslot3pm
Base class for implementation of the timeslot aggregator
Usage
use Lire::Timeslot;Overview
This module is the base class for implementation of the timeslot aggregator. This aggregator will split the DLF records based on a unit of time. For example, if the unit is 1h, all DLF records occuring on the same hour of day (independant of the day on which it occurs) are grouped 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.
- unit
-
This mandatory parameter should contains the time unit that will be used to group the records. See the
unit()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.
unit( [$new_unit])
Returns the time unit that will be used to group the DLF records. The unit is expressed as a duration value (for example 1s), but it should be noted that this will group the records based on the second unit of the DLF record's timestamp value. It could also be the name of a report specification's parameter containing a duration value.
The time unit can be changed by using the $new_unit parameter.
Version
$Id: Timeslot.pm,v 1.27 2006/07/23 13:16:30 vanbaal Exp $
Releases
6 releases since Debian 3.1 (Sarge); the text changed 5 times.