lire::timegroup(3pm) [debian man page]
Timegroup(3pm) LogReport's Lire Documentation Timegroup(3pm) NAME
Lire::Timegroup - 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. SEE ALSO
Lire::ReportSpec(3pm), Lire::Group(3pm), Lire::ReportOperator(3pm), Lire::Timeslot(3pm) AUTHORS
Francis J. Lacoste <flacoste@logreport.org> Wolfgang Sourdeau <Wolfgang.Sourdeau@Contre.COM> VERSION
$Id: Timegroup.pm,v 1.33 2006/07/23 13:16:30 vanbaal Exp $ COPYRIGHT
Copyright (C) 2001-2004 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. Lire 2.1.1 2006-07-23 Timegroup(3pm)
Check Out this Related Man Page
Group(3pm) LogReport's Lire Documentation Group(3pm) NAME
Lire::Group - Base class for implementation of the group aggregator SYNOPSIS
use Lire::Group; DESCRIPTION
This module is the base class for implementation of the group aggregator. This aggregator will split the DLF records in groups having the same key. The key is made up of one or more several non-numerical fields. The number of keys to keep in the report can be configured through the limit attribute. The keys can also be sorted using the sort attribute. CONSTRUCTOR
new( %params ) Creates a new instance of a group aggregator. In addition to the normal report operator parameters, the limit attribute can be initialized at creation time. METHODS
limit( [$new_limit] ) Returns the number of keys to display in the report. This can be an integer or the name of one of the report specification parameter (when it starts by $). The limit attribute can be changed by passing a $new_limit parameter. sort_fields( [$new_sort_fields] ) Returns fields and/or operator values which are going to be used to sort the entries generated by this aggregator. This is an array reference containing group field names and/or operator's name. The sorting fields can be changed by passing a new array reference. group_fields( [$new_fields] ) Returns as a reference to an array of Lire::GroupField objects the DLF fields that are used to group the records. If the $new_fields is set, the DLF fields used to group the records will be changed. This parameter should be a reference to an array of Lire::GroupField objects. binary_insert Recursive function that uses a binary search to insert $item in $array using $cmp as comparison operator. $first_idx and $max_idx specify the boundaries of the search. Search ends when $first_idx == $max_idx or when $sort_key sorts at or before $first_idx or at or after $max_idx SEE ALSO
Lire::ReportSpec(3pm), Lire::GroupField(3pm), Lire::ReportOperator(3pm) AUTHORS
Francis J. Lacoste <flacoste@logreport.org> Wolfgang Sourdeau <wsourdeau@logreport.org> VERSION
$Id: Group.pm,v 1.36 2006/07/23 13:16:29 vanbaal Exp $ COPYRIGHT
Copyright (C) 2001-2004 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. Lire 2.1.1 2006-07-23 Group(3pm)