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)

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

NAME

       Lire::DlfAnalyser - Base interface for all DLF analysers.

SYNOPSIS

	 use base qw/ Lire::DlfAnalyser /;

DESCRIPTION

       This package defines the interface that must be implemented by all DLF Analysers. All the methods defined in this package will throw a
       'method not implemented' exception if they are called.

       Analyser which produce DLF records for an extended schema should probably use the simpler Lire::DlfCategoriser interface.

META INFORMATION METHODS

       These methods provides information to the Lire framework about the DLF analysers.

       The Lire::DlfAnalyser interface extends the Lire::Plugin interface, so they must implement all standard meta-information methods (name(),
       title(), description()).

   src_schema()
       Returns the Dlf schema which is analysed by this analyser.

       E.g. "www"

   dst_schema()
       Returns the Dlf schema which is producted by this analyser.

       E.g. "www-user_session"

IMPLEMENTATION METHOD

       The analyser does its job using the analyse() method.

   analyse( $process, $config )
       The $process parameter contains the Lire::DlfAnalyserProcess object which is controlling the conversion process.

       The $config parameter contains configuration data that was specified in the AnalysisJob for that converter. To register configuration
       specification for you DlfAnalyser, you just need to define a configuration specification under the name analyser_name_properties. This
       should be either a RecordSpec or ObjectSpec.

SEE ALSO

       Lire::DlfAnalyserProcess(3pm), Lire::DlfStore(3pm), Lire::PluginManager(3pm), Lire::DlfCategoriser(3pm).

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: DlfAnalyser.pm,v 1.4 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							  DlfAnalyser(3pm)