Lire::ReportSpec(3pm)

Lire::ReportSpec3pm

Api to the xml report specifications.

Usage

    use Lire::ReportSpec;

Overview

Meta information methods

list_specs( $superservice )

Returns an array reference containing all the report specification type available for the $superservice superservice.

has_spec( $superservice, $type )

Returns true if there is a $type specification available for the $superservice.

Object methods

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.

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.

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.

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.

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.

mark_missing( $reason )

Mark that the report that should be generated by this report specification should be marked as missing. The $reason parameter gives the reason why the subreport will be missing.

is_missing()

Returns true if the subreport generated by this report specification should be marked missing.

set_store( $store )

Sets the DLF store upon which this ReportSpec will be generated when create_subreport() will be called.

create_subreport()

Creates a Lire::Report::Subreport object based on this report specification. This will be a missing subreport if the mark_missing() method was called.

Called by Lire::ReportSection::create_report_section().

create_table_info()

Returns a Lire::Report::TableInfo object that describes the table generated by subreport of this type.

Version

$Id: ReportSpec.pm,v 1.59 2006/07/23 13:16:30 vanbaal Exp $

Releases

5 releases since Debian 4.0 (Etch); the text changed 4 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7
  5. Arch

Author

  Francis J. Lacoste <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.