Koha/RecordProcessor/Base.pm

   1 package Koha::RecordProcessor::Base;
   2
   3 # Copyright 2012 C & P Bibliography Services
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 =head1 NAME
  21
  22 Koha::RecordProcessor::Base - Base class for RecordProcessor filters
  23
  24 =head1 SYNOPSIS
  25
  26   use base qw(Koha::RecordProcessor::Base);
  27
  28 =head1 DESCRIPTION
  29
  30 Base class for record normalizer filters. RecordProcessors must
  31 provide the following methods:
  32
  33 B<filter ($record)> - apply the filter and return the result. $record
  34 may be either a scalar or an arrayref, and the return result will be
  35 the same type.
  36
  37 The following variables must be defined in each filter:
  38   our $NAME ='Filter';
  39   our $VERSION = '1.0';
  40
  41 These methods may be overriden:
  42
  43 B<initialize (%params)> - initialize the filter
  44
  45 B<destroy ()> - destroy the filter
  46
  47 These methods should not be overridden unless you are very sure of what
  48 you are doing:
  49
  50 B<new ()> - create a new filter object
  51
  52 Note that the RecordProcessor will not clone the record that is
  53 passed in. If you do not want to change the original MARC::Record
  54 object (or whatever type of object you are passing in), you must
  55 clone it I<prior> to passing it off to the RecordProcessor.
  56
  57 =head1 FUNCTIONS
  58
  59 =cut
  60
  61 use strict;
  62 use warnings;
  63
  64 use base qw(Class::Accessor);
  65
  66 __PACKAGE__->mk_ro_accessors(qw( name version ));
  67 __PACKAGE__->mk_accessors(qw( params ));
  68 our $NAME = 'Base';
  69
  70
  71 =head2 new
  72
  73     my $filter = Koha::RecordProcessor::Base->new;
  74
  75 Create a new filter;
  76
  77 =cut
  78 sub new {
  79     my $class = shift;
  80
  81     my $self = $class->SUPER::new( { });#name => $class->NAME,
  82                                      #version => $class->VERSION });
  83
  84     bless $self, $class;
  85     return $self;
  86 }
  87
  88
  89 =head2 initialize
  90
  91     $filter->initalize(%params);
  92
  93 Initialize a filter using the specified parameters.
  94
  95 =cut
  96 sub initialize {
  97     my $self = shift;
  98     my $params = shift;
  99
 100     $self->params($params);
 101
 102     return $self;
 103 }
 104
 105
 106 =head2 destroy
 107
 108     $filter->destroy();
 109
 110 Destroy the filter.
 111
 112 =cut
 113 sub destroy {
 114     my $self = shift;
 115     return;
 116 }
 117
 118 =head2 filter
 119
 120     my $newrecord = $filter->filter($record);
 121     my $newrecords = $filter->filter(\@records);
 122
 123 Filter the specified record(s) and return the result.
 124
 125 =cut
 126 sub filter {
 127     my $self = shift;
 128     my $record = shift;
 129     return $record;
 130 }
 131
 132 1;