lire::dlfstream(3pm) [debian man page]

DlfStream(3pm)						  LogReport's Lire Documentation					    DlfStream(3pm)

NAME

       Lire::DlfStream - Interface to DLF data stream

SYNOPSIS

	 use Lire::DlfStore;

	 my $store = Lire::DlfStore->open( "mystore" );
	 my $dlf_stream = $store->open_dlf_stream( "www", "r" );

	 print "Data begins on ", scalar localtime $dlf_stream->start_time(), "
";
	 print "Data ends on   ", scalar localtime $dlf_stream->end_time(), "
";
	 while ( my $dlf = $dlf_stream->read_dlf() ) {
	   ...
	 }

DESCRIPTION

       This object encapsulates DLF stream.

   name
       Returns the schema's name of the DlfStream.

   mode()
       Returns the mode in which the DlfStream was opened.

   sort_spec()
       Returns the sort specification that is set on the stream.

   close()
       This method should be called when the Lire::DlfStream isn't needed anymore, otherwise the same DlfStream cannot be opened until then.

   nrecords()
       Returs the number of DLF records in the stream.

   start_time()
       Returns the timestamp of the oldest DLF record in the stream in seconds since the epoch.

   end_time()
       Returns the timestamp of the newest DLF record in the stream in seconds since the epoch.

   read_dlf()
       Returns an hash reference containing the next DLF record in the stream. It returns undef once the end of the stream is reached.

       This method will throw an exception if the DlfStream isn't open in 'r' mode or if there is an error reading the DLF record.

   read_dlf_aref()
       Returns the next DLF record in the stream as an array reference. The fields are in the order specified by the schema.

       This method will throw an exception if the DlfStream isn't open in 'r' mode or if there is an error reading the DLF record.

   write_dlf( $dlf, [ $link_ids ] )
       Writes the fields contained in the hash ref $dlf to the DLF stream.

       This method will throw an exception if there is an error writing the DLF record or if the stream isn't opened in 'w' mode.

       The $link_ids parameter is used when the stream's schema is a Lire::DerivedSchema. It should be an array reference containing the DLF ids
       of the records which are linked to this record.

   clean( [ $time ] )
       This method will remove all DLF records older than $time. It $time is omitted, all Dlf records will be removed.

Lire 2.1.1							    2006-07-23							    DlfStream(3pm)

DlfAnalyserProcess(3pm) 				  LogReport's Lire Documentation				   DlfAnalyserProcess(3pm)

NAME

       Lire::DlfAnalyseProcess - Object that controls the analysis process.

SYNOPSIS

	 use Lire::DlfStore;
	 use Lire::DlfAnalyserProcess;

	 my $store = Lire::DlfStore->open( "store" );

	 my $process = new Lire::DlfAnalyserProcess( $store, $analyser_name,
						     $analyser_config, $dlf_source );

	 $process->run_analysis_job();

	 print "DLF records created: ", $process->dlf_count(),	  "
";
	 print "Errors encountered: ",	$process->errors_count(), "
";

DESCRIPTION

       This object encapsulates the Lire DLF analysis process. It takes as a Lire::DlfStore, the name of the analyser, its configuration and
       optionally, a dlf_source ID. When a dlf_source is used, the analysis will only be done using the DLF coming from that source.

       The object provides the API to the converter. Methods are also available to query information on the conversion process.

new( $store, $analyser_name, $analyser_config, [ $dlf_source ] );
       Create a Lire::DlfAnalysisProcess.

   run_analysis_job()
       Import the log data from ImportJob as DLF. This method will throw an exception if it is called more than once.

   job_id()
       Returns the job identifier associated to this process.

   dlf_store()
       Returns the Lire::DlfStore in which this conversion process is storing the DLF records.

   dlf_source()
       Returns the source from which the DLF should come in the src_schema to be analysed.

   dlf_analyser()
       Returns the name of the analyser which will be run.

   dlf_analyser_config()
       Returns the analysis configuration data that should be used by the converter.

   dlf_count()
       Returns the number of DLF records created.

   error_count()
       Returns the number of errors encountered in the conversion process.

   source_filter()
       Returns a Lire::FilterExpr which should be used to limit the DLF records to analyse.

       This method returns null if the whole DLF stream should be analysed.

API FOR THE DLF ANALYSERS

       This is the object that encapsulates the DLF implementation and hides the complexitity of the storage framework from the DLF analysers. It
       offers the following methods to the DLf converter.

   write_dlf(  $dlf, [$related_to] )
       This writes the $dlf DLF record conforming the $schema's schema in the Lire::DlfStore. $Dlf is an hash reference. Keys are the schema's
       field name. Undefined value means that this field isn't available in that record.

       When writing to a derived schema, the $related_to parameter can be an arrayr reference containing the dlf_ids of the related record.

   error( $error_msg );
       Method that should be used by the Lire::Analyser to report that an error was encountered during the analysis process. $error_msg should be
       used to report the nature of the error.

SEE ALSO

       Lire::DlfStore(3pm) Lire::DlfAnalyser(3pm)

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: DlfAnalyserProcess.pm,v 1.10 2006/07/23 13:16:28 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.

Lire 2.1.1							    2006-07-23						   DlfAnalyserProcess(3pm)