.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" 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 .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "Rangegroup 3pm" .TH Rangegroup 3pm 2025-09-28 "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::Group \- Base class for implementation of the rangegroup aggregator .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Lire::Rangegroup; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module is the base class for implementation of the rangegroup aggregator. This aggregator will split the DLF records based on a numerical field. The so\-called range groups creates numerical classes (e.g. 1\-10, 11\-20, etc.) and the DLF record will be grouped with other records which are in the same class. .SH CONSTRUCTOR .IX Header "CONSTRUCTOR" .ie n .SS "new( %params )" .el .SS "new( \f(CW%params\fP )" .IX Subsection "new( %params )" Creates a new instance of a group aggregator. In addition to the normal report operator parameters, the rangegroup aggregator can take several parameters: .IP field 4 .IX Item "field" This parameter is mandatory. It should be the name of the DLF field which will be used as key for this aggregator. .IP range\-size 4 .IX Item "range-size" This parameter is mandatory. This will be used as the size of each range group. .IP range\-start 4 .IX Item "range-start" The number at which the first range group starts. Defauls to 0. .IP min\-value 4 .IX Item "min-value" Value lower than this number will be sorted in the first range group. .IP max\-value 4 .IX Item "max-value" Value higher than this number will be sorted in the last range group. .IP size\-scale 4 .IX Item "size-scale" This parameter can be used to create a logarithmic scale. In this case, each new range group will be size\-scale bigger than the one that comes before it. For example, setting range\-size=5 and size\-scale=2 will create ranges like [0\-5>, [5\-15>, [15\-35>, ... .SH METHODS .IX Header "METHODS" .SS "field( [$new_field] )" .IX Subsection "field( [$new_field] )" Returns the name of the DLF field which is used as grouping key. .PP If the \f(CW$new_field\fR parameter is set, it changes the grouping field. This must be the name of a quantity type field in the report specifications DLF schema. .SS "range_start( [$new_start] )" .IX Subsection "range_start( [$new_start] )" Returns the number which is the starting bound of the first range group. .PP If the \f(CW$new_start\fR parameter is set, it changes the starting bound of the first range group. This should either be a positive integer or the name of one of the report specification\*(Aqs parameter. .SS "range_size( [$new_size] )" .IX Subsection "range_size( [$new_size] )" Returns the width of each range group. .PP If the \f(CW$new_size\fR parameter is set, it changes the width of each range group. This should either be a positive integer or the name of one of the report specification\*(Aqs parameter. .SS "min_value( [$new_min] )" .IX Subsection "min_value( [$new_min] )" Returns the number below which no new range groups will be created. .PP If the \f(CW$new_min\fR is set, it changes the lower bound below which no new groups will be created. This should either be a number or the name of one of the report specification\*(Aqs parameter. .SS "max_value( [$new_max] )" .IX Subsection "max_value( [$new_max] )" Returns the number above which no new range groups will be created. .PP If the \f(CW$new_max\fR is set, it changes the upper bound above which no new groups will be created. This should either be a number or the name of one of the report specification\*(Aqs parameter. .SS "size_scale( [$new_size_scale] )" .IX Subsection "size_scale( [$new_size_scale] )" Returns the multiplier that will be apply to each of the range group\*(Aqs width after the first one. .PP When this attribute is greater than 1, it creates a logarithmic scale where each new ranges is \f(CW$size_scale\fR wider than the precedent one. .PP If the \f(CW$new_size_scale\fR parameter is used, it changes the attribute to this new value. It should be a positive interger or can also be a parameter reference. .SH "SEE ALSO" .IX Header "SEE ALSO" .Vb 2 \& Lire::ReportSpec(3pm), Lire::Group(3pm), Lire::ReportOperator(3pm), \& Lire::Aggregator(3pm) .Ve .SH AUTHORS .IX Header "AUTHORS" .Vb 2 \& Francis J. Lacoste \& Wolfgang Sourdeau .Ve .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR Rangegroup.pm,v 1.25 2006/07/30 10:50:17 vanbaal Exp $ .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2001\-2004 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.