.\" 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 "ImportJob 3pm"
.TH ImportJob 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::ImportJob \- Object used to represent an periodical source of log data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::ImportJob;
\&
\&  my $src = new Lire::ImportJob( "name",
\&                                 \*(Aqpattern\*(Aq    => "/var/log/messsages",
\&                                 \*(Aqperiod\*(Aq     => "unique",
\&                                 \*(Aqprocessor\*(Aq  => $name,
\&                                );
\&
\&  my $file = $src\->file,
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Lire::ImportJob object is used to represent a source of log data.
ImportJobs can also be instantiated from configuration data (The
\&'import_job' configuration specification.)
.ie n .SH "new( $name, ... );"
.el .SH "new( \f(CW$name\fP, ... );"
.IX Header "new( $name, ... );"
Create a new Lire::ImportJob object. As mandatory parameter, it takes
the name of the log source.
.PP
Additional parameters:
.IP "pattern" 4
.IX Item "pattern"
The path to the file that contains the log data. This filename can
contain \fIstrftime\fR\|(3) patterns that will be substituted to obtain the
name of the file. (Useful for automatic rotation).
.IP "period" 4
.IX Item "period"
The periodicity to which this ImportJob should be processed. Defaults
to 'unique' which means this is a one-shot ImportJob. Other
recognized values are 'hourly', 'daily', 'weekly', 'monthly' and 'yearly'.
.IP "converter" 4
.IX Item "converter"
The name of the converter that can be used to process the ImportJob.
This must be known to the Lire::PluginManager.
.IP "converter_config" 4
.IX Item "converter_config"
Configuration parameter for the DlfConverter.
.IP "filter" 4
.IX Item "filter"
A shell command that will be used to filter the log file.
.IP "encoding" 4
.IX Item "encoding"
Encoding for the log file. If omitted, the default system encoding
will be used.
.SS "\fIname()\fP"
.IX Subsection "name()"
Returns the name of this ImportJob.
.SS "period( [$new_period] )"
.IX Subsection "period( [$new_period] )"
With no argument, returns the period of this ImportJob. With a
parameter, the ImportJob's period is set to this new value.
.SS "file( [$time] )"
.IX Subsection "file( [$time] )"
Returns the file to be used. The optional \f(CW$time\fR parameter (which
defaults to now) is used to compute the file name. To find the file to
use for yesterday's data, one could pass time \- 86400.
.SS "pattern( [$new_file] )"
.IX Subsection "pattern( [$new_file] )"
Returns the file pattern to use as log data source. This pattern may
contain \fIstrftime\fR\|(3) substitutions. If an argument is used, it will
change the file to use.
.SS "filter( [$new_filter] )"
.IX Subsection "filter( [$new_filter] )"
Returns the shell command that will be used as filter. Undef or ''
will not use a filter.
.SS "encoding( [$new_encoding] )"
.IX Subsection "encoding( [$new_encoding] )"
Returns the encoding of the log file. Undef and '' means to use
the system default encoding.
.SS "converter( [$new_name] )"
.IX Subsection "converter( [$new_name] )"
Returns the name of the converter that should be used for this
ImportJob.
.SS "converter_config( [$new_config] )"
.IX Subsection "converter_config( [$new_config] )"
Returns a configuration object that should be used by the DlfConverter
(through the \fIset_configuration()\fR method).
.ie n .SS "log_fh( [ $time ] )"
.el .SS "log_fh( [ \f(CW$time\fP ] )"
.IX Subsection "log_fh( [ $time ] )"
Returns a file handle that can be used to read from the log. \f(CW$time\fR is
the parameter taken by file to determine the final filename. All
filters and encoding will be setup properly.
.ie n .SS "run( $store, [$time] )"
.el .SS "run( \f(CW$store\fP, [$time] )"
.IX Subsection "run( $store, [$time] )"
Runs this ImportJob and import it into the \f(CW$store\fR DlfStore. The \f(CW$time\fR
parameter will be used to determine the time window covered by period.
It defaults to the current time.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::DlfStore\fR\|(3pm) \fILire::DlfConverter\fR\|(3pm)
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR ImportJob.pm,v 1.14 2006/07/23 13:16:29 vanbaal Exp $
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2002\-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.