/usr/share/perl5/Lire/DlfAnalyser.pm is in lire 2:2.1.1-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | package Lire::DlfAnalyser;
use strict;
use base qw/Lire::Plugin/;
use Carp;
=pod
=head1 NAME
Lire::DlfAnalyser - Base interface for all DLF analysers.
=head1 SYNOPSIS
use base qw/ Lire::DlfAnalyser /;
=head1 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.
=head1 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()).
=pod
=head2 src_schema()
Returns the Dlf schema which is analysed by this analyser.
E.g. C<www>
=cut
sub src_schema {
croak "src_schema() not implemented by ", ref $_[0] || $_[0];
}
=pod
=head2 dst_schema()
Returns the Dlf schema which is producted by this analyser.
E.g. C<www-user_session>
=cut
sub dst_schema {
croak "dst_schema() not implemented by ", ref $_[0] || $_[0];
}
sub type { return 'dlf_analyser' }
=head1 IMPLEMENTATION METHOD
The analyser does its job using the analyse() method.
=head2 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
I<analyser_name>_properties. This should be either a RecordSpec or
ObjectSpec.
=cut
sub analyse {
croak "analyse() not implemented by ", ref $_[0] || $_[0];
}
# keep perl happy
1;
__END__
=pod
=head1 SEE ALSO
Lire::DlfAnalyserProcess(3pm), Lire::DlfStore(3pm),
Lire::PluginManager(3pm), Lire::DlfCategoriser(3pm).
=head1 AUTHOR
Francis J. Lacoste <flacoste@logreport.org>
=head1 VERSION
$Id: DlfAnalyser.pm,v 1.4 2006/07/23 13:16:28 vanbaal Exp $
=head1 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.
=cut
|