.\" -*- 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 "Aggregate 3pm"
.TH Aggregate 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::Aggregate \- Base class for all operators that compute values from a group
of DLF records
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::Aggregate;
\&
\&    use base qw/ Lire::Aggregate /;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Lire::Aggregate is the base class of all operators that computes
values from a group of DLF records. These are the operators that are
used inside aggregators.
.PP
This package also defines most of the classes that represents the
group operators available in Lire report specification.
.SH "METHODS FOR SUBCLASSES OF Aggregate"
.IX Header "METHODS FOR SUBCLASSES OF Aggregate"
.ie n .SS "init( %params )"
.el .SS "init( \f(CW%params\fP )"
.IX Subsection "init( %params )"
Two supplemental parameters are needed for Aggregates:
.IP parent 4
.IX Item "parent"
The Lire::Aggregator which contain this Aggregate.
.IP name 4
.IX Item "name"
The identifier that can be used to find this operator in the report
specification. It will be returned by the \fBname()\fR method.
.ie n .SS "print( $fh, $prefix)"
.el .SS "print( \f(CW$fh\fP, \f(CW$prefix\fP)"
.IX Subsection "print( $fh, $prefix)"
This methods implements the \fBprint()\fR method required by
Lire::ReportOperator. It prints an empty XML element named after \fBop()\fR.
It also takes care of writing the name and label attributes. Other
attributes can be added to the XML element by overriding the
\&\fBxml_attrs()\fR method.
.SS \fBxml_attrs()\fP
.IX Subsection "xml_attrs()"
This method can be used to write additional XML attributes. The
returned string will be output in the XML element.
.ie n .SS "set_name( $name )"
.el .SS "set_name( \f(CW$name\fP )"
.IX Subsection "set_name( $name )"
Changes this operator\*(Aqs name.
.ie n .SS "create_numerical_info( $group_info )"
.el .SS "create_numerical_info( \f(CW$group_info\fP )"
.IX Subsection "create_numerical_info( $group_info )"
Subclass must implement this method.
.PP
The \f(CW$group_info\fR parameter is a Lire::Report::GroupInfo object to which
the operator implementation should add the appropriate ColumnInfo object to 
represent the data generated by the aggregate.
.ie n .SS "build_query( $query )"
.el .SS "build_query( \f(CW$query\fP )"
.IX Subsection "build_query( $query )"
FIXME.
.PP
Provides a default implementation of build_query
.ie n .SS "set_missing_cases_aggr_expr( $query )"
.el .SS "set_missing_cases_aggr_expr( \f(CW$query\fP )"
.IX Subsection "set_missing_cases_aggr_expr( $query )"
Adds the aggregate expression to compute the number of missing cases
based on the required fields returned by the \fBsql_required_fields()\fR
method.
.PP
The method \fBset_missing_cases_value()\fR can be used to set the value from
the returned DLF row.
.ie n .SS "set_missing_cases_value( $row, $value )"
.el .SS "set_missing_cases_value( \f(CW$row\fP, \f(CW$value\fP )"
.IX Subsection "set_missing_cases_value( $row, $value )"
Sets the missing\-cases value in \f(CW$value\fR to the value computed by the
expression sets using \fBset_missing_cases_aggr_expr()\fR.
.SS \fBsql_aggr_expr()\fP
.IX Subsection "sql_aggr_expr()"
Method used by the default implementation of \fBbuild_query()\fR. It should
return the SQL agregate expression that should be associated to this
Aggregate\*(Aqs name. For example, a simple Count implementation could
have returned \*(Aqcount(*)\*(Aq here.
.SS \fBsql_required_fields()\fP
.IX Subsection "sql_required_fields()"
Method used by the \fBset_missing_cases_aggr_expr()\fR to sets an aggregate
expression that will return the number of missing cases for this
aggregate. It should returns a list of fields that will create a
missing case when a value is NULL.
.ie n .SS "create_value( $parent_group, $row )"
.el .SS "create_value( \f(CW$parent_group\fP, \f(CW$row\fP )"
.IX Subsection "create_value( $parent_group, $row )"
Method that is used by Aggregator when building the report table. The
report should return an hash reference with the appropriate keys set.
Consult \fBLire::Report::Entry\fR\|(3pm) for details.
.PP
The \f(CW$parent_group\fR parameter is the Lire::Report::Group to which the
value is added. This will be the table or containing group for values
added to Entries, and it will be the Group\*(Aqs parent when creating a
summary value.
.PP
The \f(CW$row\fR parameter is an hash ref containing the DlfResult row for
which the value should be created.
.PP
Implementation should use the \fBset_missing_cases_value()\fR method to set
the value\*(Aqs \*(Aqmissing_cases\*(Aq attribute.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportSpec\fR\|(3pm), \fBLire::ReportOperator\fR\|(3pm), \fBLire::Aggregator\fR\|(3pm).
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Aggregate.pm,v 1.16 2006/07/23 13:16:27 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2003 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.