Provided by: lire-devel-doc_2.1-1.1_all bug

NAME

       Lire::ReportSchedule - Object which reprents one periodical report generation.

SYNOPSIS

         use Lire::ReportJob;
         use Lire::ReportSchedule;

         my $store = Lire::DlfStore->open( 'aStore' );
         my $job = new Lire::ReportJob( "webServer" );
         my $cfg = $store->get_report_config( 'daily_www_report' );
         $job->add_schedule( new Lire::ReportSchedule( 'daily', $cfg );
         $job->run( 'daily', $store );

DESCRIPTION

       Lire::ReportSchedule objects together with Lire::OutputJob objects make it possible to
       configure all kind of periodical report generation. Whereas the Lire::OutputJob is used to
       represent the formatting of one generated report, the Lire::ReportSchedule represents such
       a generation. It will be use to generate periodically one XML report in a DlfStore using
       one report configuration file.

       ReportSchedules grouped together in one ReportJob are assumed to generate compatible
       reports as far as merging is concerned. The idea is that previous reports generated in one
       ReportJob (according to different schedules) could be used as a data source when the
       DlfStore doesn't contain all the DLF records for the whole period. For example, if you
       don't keep one year of www DLF in your store, you could still generate an yearly report
       using the daily reports generated during the year.

   new( $period, $cfg );
       Creates a new Lire::ReportSchedule that will generates an XML report using the
       Lire::ReportConfig $cfg on a $period period.  $period should be one of 'hourly', 'daily',
       'weekly', 'monthly' or 'yearly'.

   period()
       Returns the period of this ReportSchedule.

   period_range( [ $time ] )
       Returns the starting and ending boundaries of the schedule period which includes $time.
       (Defaults to now). The ending boundary is excluded from the period and the starting
       boundary is included.

   report_config( [ $new_cfg ] )
       Returns (and optionally change) the Lire::ReportConfig object to use for this schedule.

   init_report_config( [ $time ] )
       Returns the Lire::ReportConfig object with filters set. A FilterSpec will have been added
       to each section of the ReportConfig object which will restrict the reporting on the period
       defined for the scedule. The boundaries of the period are determined according to $time
       which defaults to now.

   add_output_jobs( $job, ... )
       Adds one or more Lire::OutputJob to the ReportSchedule object.

   output_jobs()
       Returns the Lire::OutputJobs related to this object.

   run( $store, $report_job, [$time]  )
       Generate a XML report and save it in the $store Lire::DlfStore. The report will be
       generated either using the DlfStreams or previously generated reports. Preferences is
       giving to generating the report using the Dlf data For more details, consult the
       documentation of find_report_source() in Lire::DlfStore(3pm).

       The period for which the report will be generated is done using the $time parameter which
       defaults to now. For example, a 'daily' report will generate a report for the whole day
       (midnight-midnidht based on the day that $time represents).

       Once the report is generated, all registered OutputJob will be run with the new report.

SEE ALSO

       Lire::DlfStore(3pm) Lire::DlfConverter(3pm)

AUTHOR

         Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: ReportSchedule.pm,v 1.17 2006/07/23 13:16:29 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       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.

       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.

       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.