Koha/MetadataRecord.pm

   1 package Koha::MetadataRecord;
   2
   3 # Copyright 2013 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::MetadataRecord - base class for metadata records
  23
  24 =head1 SYNOPSIS
  25
  26     my $record = new Koha::MetadataRecord({ 'record' => $record });
  27
  28 =head1 DESCRIPTION
  29
  30 Object-oriented class that encapsulates all metadata (i.e. bibliographic
  31 and authority) records in Koha.
  32
  33 =cut
  34
  35 use Modern::Perl;
  36
  37 use Carp qw( carp );
  38 use Koha::Util::MARC;
  39
  40 use base qw(Class::Accessor);
  41
  42 __PACKAGE__->mk_accessors(qw( record schema format id ));
  43
  44
  45 =head2 new
  46
  47     my $metadata_record = new Koha::MetadataRecord({
  48                                 record => $record,
  49                                 schema => $schema,
  50                                 format => $format,
  51                                 id     => $id
  52                           });
  53
  54 Returns a Koha::MetadataRecord object encapsulating record metadata.
  55
  56 C<$record> is expected to be a deserialized object (for example
  57 a MARC::Record or XML::LibXML::Document object or JSON).
  58
  59 C<$schema> is used to describe the metadata schema (for example
  60 marc21, unimarc, dc, mods, etc).
  61
  62 C<$format> is used to specify the serialization format. It is important
  63 for Koha::RecordProcessor because it will pick the right Koha::Filter
  64 implementation based on this parameter. Valid values are:
  65
  66    MARC (for MARC::Record objects)
  67    XML  (for XML::LibXML::Document objects)
  68    JSON (for JSON objects)
  69
  70 (optional) C<$id> is used so the record carries its own id and Koha doesn't
  71 need to look for it inside the record.
  72
  73 =cut
  74
  75 sub new {
  76
  77     my $class  = shift;
  78     my $params = shift;
  79
  80     if (!defined $params->{ record }) {
  81         carp 'No record passed';
  82         return;
  83     }
  84
  85     if (!defined $params->{ schema }) {
  86         carp 'No schema passed';
  87         return;
  88     }
  89
  90     $params->{format} //= 'MARC';
  91     my $self = $class->SUPER::new($params);
  92
  93     bless $self, $class;
  94     return $self;
  95 }
  96
  97 =head2 createMergeHash
  98
  99 Create a hash for use when merging records. At the moment the only
 100 metadata schema supported is MARC.
 101
 102 =cut
 103
 104 sub createMergeHash {
 105     my ($self, $tagslib) = @_;
 106     if ($self->schema =~ m/marc/) {
 107         return Koha::Util::MARC::createMergeHash($self->record, $tagslib);
 108     }
 109 }
 110
 111 1;