.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ReportSpec 3pm"
.TH ReportSpec 3pm "2006-07-23" "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 "\fIchart_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 "\fIis_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 \s-1DLF\s0 store upon which this ReportSpec will be generated when
\&\fIcreate_subreport()\fR will be called.
.SS "\fIcreate_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 \fImark_missing()\fR
method was called.
.PP
Called by \fILire::ReportSection::create_report_section()\fR.
.SS "\fIcreate_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 \s-1GNU\s0 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 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.