.\" -*- 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 "ReportSpec 3pm"
.TH ReportSpec 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::ReportSpec \- API to the XML report specifications.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::ReportSpec;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SH "META INFORMATION METHODS"
.IX Header "META INFORMATION METHODS"
.ie n .SS "list_specs( $superservice )"
.el .SS "list_specs( \f(CW$superservice\fP )"
.IX Subsection "list_specs( $superservice )"
Returns an array reference containing all the report specification
type available for the \f(CW$superservice\fR superservice.
.ie n .SS "has_spec( $superservice, $type )"
.el .SS "has_spec( \f(CW$superservice\fP, \f(CW$type\fP )"
.IX Subsection "has_spec( $superservice, $type )"
Returns true if there is a \f(CW$type\fR specification available for the
\&\f(CW$superservice\fR.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.ie n .SS "subreport_id( [ $new_subreport_id ] )"
.el .SS "subreport_id( [ \f(CW$new_subreport_id\fP ] )"
.IX Subsection "subreport_id( [ $new_subreport_id ] )"
Returns (and optionnally change) the id that will be associated
to the Subreport that will be generated by this specification.
.SS \fBchart_configs()\fP
.IX Subsection "chart_configs()"
Returns an array reference containing the Lire::Report::ChartConfig
objects that specifies the charts that should be generated when the
Lire::Report::Subrpeport object specified by this object will be
formatted.
.ie n .SS "add_chart_config( $chart_config )"
.el .SS "add_chart_config( \f(CW$chart_config\fP )"
.IX Subsection "add_chart_config( $chart_config )"
Adds a Lire::Report::ChartConfig object that should be added to the
Lire::Report::Subreport object that is specified by this object.
.ie n .SS "filter_spec( [ $new_filter_spec ] )"
.el .SS "filter_spec( [ \f(CW$new_filter_spec\fP ] )"
.IX Subsection "filter_spec( [ $new_filter_spec ] )"
Returns (and optionally changes) the Lire::FilterExpr that should be
applied to create the Lire::Report::Subreport specified by this
object. This will be undef if no filtering should be applied.
.ie n .SS "calc_spec( [ $new_aggregator ] )"
.el .SS "calc_spec( [ \f(CW$new_aggregator\fP ] )"
.IX Subsection "calc_spec( [ $new_aggregator ] )"
Returns (and optionally changes) the Lire::Aggregator that should be
used to create the Lire::Report::Subreport specified by this object.
.ie n .SS "mark_missing( $reason )"
.el .SS "mark_missing( \f(CW$reason\fP )"
.IX Subsection "mark_missing( $reason )"
Mark that the report that should be generated by this report
specification should be marked as missing. The \f(CW$reason\fR parameter gives
the reason why the subreport will be missing.
.SS \fBis_missing()\fP
.IX Subsection "is_missing()"
Returns true if the subreport generated by this report specification
should be marked missing.
.ie n .SS "set_store( $store )"
.el .SS "set_store( \f(CW$store\fP )"
.IX Subsection "set_store( $store )"
Sets the DLF store upon which this ReportSpec will be generated when
\&\fBcreate_subreport()\fR will be called.
.SS \fBcreate_subreport()\fP
.IX Subsection "create_subreport()"
Creates a Lire::Report::Subreport object based on this report
specification. This will be a missing subreport if the \fBmark_missing()\fR
method was called.
.PP
Called by \fBLire::ReportSection::create_report_section()\fR.
.SS \fBcreate_table_info()\fP
.IX Subsection "create_table_info()"
Returns a Lire::Report::TableInfo object that describes the table
generated by subreport of this type.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\&  Lire::FilterSpec(3pm), Lire::ReportConfig(3pm),
\&  Lire::ReportSection(3pm)
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR ReportSpec.pm,v 1.59 2006/07/23 13:16:30 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.