use strict;
use XML::Twig;
-use Equinox::Migration::SubfieldMapper 1.002;
+use Equinox::Migration::SubfieldMapper 1.004;
+
=head1 NAME
=head1 VERSION
-Version 1.000
+Version 1.005
=cut
-our $VERSION = '1.000';
+our $VERSION = '1.005';
+
+my $dstore;
+my $sfmap;
+my @modlist = qw( multi ignoremulti bib required first concatenate );
+my %allmods = ();
+my $multis = {};
+my $reccount;
+my $verbose = 0;
=head1 SYNOPSIS
my $m = Equinox::Migration::MapDrivenMARCXMLProc->new( mapfile => FILE,
marcfile => FILE );
-There is an optional third, argument, C<sample>, which specifies a
-arrayref of datafields to "sample" by reporting on subfields which are
-found in the data but not in the map.
-
- my $m = Equinox::Migration::MapDrivenMARCXMLProc->new( mapfile => FILE,
- marcfile => FILE,
- sample => \@TAGS
- );
-
-See L</UNMAPPED TAGS> for more info.
-
=cut
sub new {
my ($class, %args) = @_;
- my $self = bless { mods => { multi => {},
- once => {},
- required => {},
- },
- data => { recs => undef, # X::T record objects
- rptr => 0, # next record pointer
- crec => undef, # parsed record storage
- stag => undef, # list of tags to sample
- umap => undef, # unmapped data samples
- },
+ $verbose = 1 if $args{verbose};
+
+ my $self = bless { multis => \$multis,
}, $class;
# initialize map and taglist
- die "Argument 'mapfile' must be specified\n" unless (defined $args{mapfile});
- my @mods = keys %{$self->{mods}};
- $self->{map} = Equinox::Migration::SubfieldMapper->new( file => $args{mapfile},
- mods => \@mods );
- $self->{data}{tags} = $self->{map}->tags;
+ die "Argument 'mapfile' must be specified\n" unless ($args{mapfile});
+ $sfmap = Equinox::Migration::SubfieldMapper->new( file => $args{mapfile},
+ mods => \@modlist );
+
+ # initialize datastore
+ $dstore = {};
+ $reccount = 0; # next record ptr
+ $dstore->{tags} = $sfmap->tags; # list of all tags
+ $self->{data} = $dstore;
# initialize twig
- die "Argument 'marcfile' must be specified\n" unless (defined $args{marcfile});
+ die "Argument 'marcfile' must be specified\n" unless ($args{marcfile});
if (-r $args{marcfile}) {
- $self->{twig} = XML::Twig->new;
- $self->{twig}->parsefile($args{marcfile});
- my @records = $self->{twig}->root->children;
- $self->{data}{recs} = \@records;
+ my $xmltwig = XML::Twig->new( twig_handlers => { record => \&parse_record } );
+ $xmltwig->parsefile( $args{marcfile} );
} else {
die "Can't open marc file: $!\n";
}
return $self;
}
-
=head2 parse_record
-Extracts data from the next record, per the mapping file. Returns a
-normalized datastructure (see L</format_record> for details) on
-success; returns 0 otherwise.
-
- while (my $rec = $m->parse_record) {
- # handle extracted record data
- }
+Extracts data from the next record, per the mapping file.
=cut
sub parse_record {
- my ($self) = @_;
-
- # get the next record and wipe current parsed record
- return 0 unless defined $self->{data}{recs}[ $self->{data}{rptr} ];
- my $record = $self->{data}{recs}[ $self->{data}{rptr} ];
- $self->{data}{crec} = { egid => undef, bib => undef, tags => undef };
+ my ($twig, $record) = @_;
+ my $crec = {}; # current record
my @fields = $record->children;
for my $f (@fields)
- { $self->process_field($f) }
+ { process_field($f, $crec) }
+
+ # fill in blank values if needed
+ for my $mappedtag ( @{ $sfmap->tags }) {
+ unless (exists $crec->{tmap}{$mappedtag}) {
+ push @{ $crec->{tags} }, {};
+ for my $mappedsub ( @{ $sfmap->subfields($mappedtag) } ) {
+ my $fieldname = $sfmap->field($mappedtag, $mappedsub);
+ my $mods = $sfmap->mods($fieldname);
+ next if $mods->{multi};
+ $crec->{tags}[-1]{uni}{$mappedsub} = '';
+ $crec->{tags}[-1]{multi} = undef;
+ $crec->{tags}[-1]{tag} = $mappedtag;
+ }
+ push @{ $crec->{tmap}{$mappedtag} }, $#{ $crec->{tags} };
+ }
+ }
# cleanup memory and increment pointer
$record->purge;
- $self->{data}{rptr}++;
+ $reccount++;
- return $self->{data}{crec};
+ # check for required fields
+ check_required($crec);
+ push @{ $dstore->{recs} }, $crec;
+
+ print STDERR "$reccount\n"
+ if ($verbose and !($reccount % 1000));
}
sub process_field {
- my ($self, $field) = @_;
- my $map = $self->{map};
+ my ($field, $crec) = @_;
my $tag = $field->{'att'}->{'tag'};
- my $crec = $self->{data}{crec};
# leader
unless (defined $tag) {
$crec->{egid} = $sub->text;
return;
}
- if ($map->has($tag)) {
+ if ($sfmap->has($tag)) {
push @{$crec->{tags}}, { tag => $tag, uni => undef, multi => undef };
+ push @{$crec->{tmap}{$tag}}, (@{$crec->{tags}} - 1);
my @subs = $field->children('subfield');
for my $sub (@subs)
- { $self->process_subs($tag, $sub) }
- # check map to ensure all declared subs have a value
- my $mods = $map->mods($field);
- for my $mappedsub ( @{ $map->subfields($tag) } ) {
+ { process_subs($tag, $sub, $crec) }
+
+ # check map to ensure all declared tags and subs have a value
+ for my $mappedsub ( @{ $sfmap->subfields($tag) } ) {
+ my $fieldname = $sfmap->field($tag, $mappedsub);
+ my $mods = $sfmap->mods($fieldname);
next if $mods->{multi};
$crec->{tags}[-1]{uni}{$mappedsub} = ''
unless defined $crec->{tags}[-1]{uni}{$mappedsub};
}
sub process_subs {
- my ($self, $tag, $sub) = @_;
- my $map = $self->{map};
+ my ($tag, $sub, $crec) = @_;
my $code = $sub->{'att'}->{'code'};
# handle unmapped tag/subs
- unless ($map->has($tag, $code)) {
- my $u = $self->{data}{umap};
- my $s = $self->{data}{stag};
- return unless (defined $s->{$tag});
-
- # set a value, total-seen count and records-seen-in count
- $u->{$tag}{$code}{value} = $sub->text unless defined $u->{$tag}{$code};
- $u->{$tag}{$code}{count}++;
- $u->{$tag}{$code}{rcnt}++ unless ($u->{$tag}{$code}{last} == $self->{data}{rptr});
- $u->{$tag}{$code}{last} = $self->{data}{rptr};
+ return unless ($sfmap->has($tag, $code));
+
+ # fetch our datafield struct and field and mods
+ my $dataf = $crec->{tags}[-1];
+ my $field = $sfmap->field($tag, $code);
+ my $sep = $sfmap->sep($field);
+ $allmods{$field} = $sfmap->mods($field) unless $allmods{$field};
+ my $mods = $allmods{$field};
+
+ # test filters
+ for my $filter ( @{$sfmap->filters($field)} ) {
+ return if ($sub->text =~ /$filter/i);
+ }
+
+ # handle multi modifier
+ if ($mods->{multi}) {
+ $multis->{$tag}{$code} = 1;
+ if ($mods->{concatenate}) {
+ if (exists($dataf->{multi}{$code})) {
+ $dataf->{multi}{$code}[0] .= $sep . $sub->text;
+ } else {
+ push @{$dataf->{multi}{$code}}, $sub->text;
+ }
+ $multis->{$tag}{$code} = 1;
+ } else {
+ push @{$dataf->{multi}{$code}}, $sub->text;
+ }
return;
}
- # fetch our datafield struct and fieldname
- my $dataf = $self->{data}{crec}{tags}[-1];
- my $field = $map->field($tag, $code);
- # handle modifiers, or slug data in normally
- if (my $mods = $map->mods($field)) {
- if ($mods->{multi}) {
- my $name = $tag . $code;
- push @{$dataf->{multi}{$name}}, $sub->text;
+ if ($mods->{concatenate}) {
+ if (exists($dataf->{uni}{$code})) {
+ $dataf->{uni}{$code} .= $sep . $sub->text;
+ } else {
+ $dataf->{uni}{$code} = $sub->text;
+ }
+ return;
+ }
+
+ # if this were a multi field, it would be handled already. make sure its a singleton
+ die "Multiple occurances of a non-multi field: $tag$code at rec ",
+ ($reccount + 1),"\n" if (defined $dataf->{uni}{$code} and !$mods->{ignoremulti});
+
+ # everything seems okay
+ $dataf->{uni}{$code} = $sub->text;
+}
+
+
+sub check_required {
+ my ($crec) = @_;
+ my $mods = $sfmap->mods;
+
+ for my $tag_id (keys %{$mods->{required}}) {
+ for my $code (@{$mods->{required}{$tag_id}}) {
+ my $found = 0;
+
+ for my $tag (@{$crec->{tags}}) {
+ $found = 1 if ($tag->{multi}{($tag_id . $code)});
+ $found = 1 if ($tag->{uni}{$code});
+ }
+
+ die "Required mapping $tag_id$code not found in rec ",$reccount,"\n"
+ unless ($found);
}
- } else {
- $dataf->{uni}{$code} = $sub->text;
}
+
}
+=head2 recno
+
+Returns current record number (starting from zero)
+
+=cut
+
+sub recno { my ($self) = @_; return $self->{data}{rcnt} }
+
+=head2 name
+
+Returns mapped fieldname when passed a tag, and code
+
+ my $name = $m->name(999,'a');
+
+=cut
+
+sub name { my ($self, $t, $c) = @_; return $sfmap->field($t, $c) }
+
+=head2 first_only
+
+Returns whether mapped fieldname is to be applied only to first
+item in a bib
+
+=cut
+
+sub first_only {
+ my ($self, $t, $c) = @_;
+ my $field = $sfmap->field($t, $c);
+ my $mods = $sfmap->mods($field);
+ return exists($mods->{first});
+}
+
+=head2 get_multis
+
+Returns hashref of C<{tag}{code}> for all mapped multi fields
+
+=cut
+
+sub get_multis {
+ my ($self) = @_;
+ return $multis;
+}
+
+=head1 MODIFIERS
+
+MapDrivenMARCXMLProc implements the following modifiers, and passes
+them to L<Equinox::Migration::SubfieldMapper>, meaning that specifying
+any other modifiers in a MDMP map file will cause a fatal error when
+it is processed.
+
+=head2 multi
+
+If a mapping is declared to be C<multi>, then MDMP expects to see more
+than one instance of that subfield per datafield, and the data is
+handled accordingly (see L</PARSED RECORDS> below).
+
+Occurring zero or one time is legal for a C<multi> mapping.
+
+A mapping which is not flagged as C<multi>, but which occurs more than
+once per datafield will cause a fatal error.
+
+=head2 required
+
+By default, if a mapping does not occur in a datafield, processing
+continues normally. if a mapping has the C<required> modifier,
+however, it must appear, or a fatal error will occur.
+
=head1 PARSED RECORDS
Given:
Then C<$rec> will look like:
{
- egid => evergreen_record_id,
- bib => {
- (tag_id . sub_code)1 => value1,
- (tag_id . sub_code)2 => value2,
- ...
- },
+ egid => evergreen_record_id,
tags => [
{
tag => tag_id,
- multi => { (tag_id . sub_code) => [ val1, val2, ... ] },
+ multi => { code => [ val1, val2, ... ] },
uni => { code => value, code2 => value2, ... },
},
...
- ]
+ ],
+ tmap => { tag_id => [ INDEX_LIST ], tag_id2 => [ INDEX_LIST ], ... }
}
That is, there is an C<egid> key which points to the Evergreen ID of
-that record, a C<bib> key which points to a hashref, and a C<tags>
-key which points to an arrayref.
-
-=head3 C<bib>
-
-A reference to a hash which holds extracted data which occurs only
-once per record (and is therefore "bib-level"; the default assumption
-is that a tag/subfield pair can occur multiple times per record). The
-keys are composed of tag id and subfield code, catenated
-(e.g. 901c). The values are the contents of that subfield of that tag.
-
-If there are no tags defined as bib-level in the mapfile, C<bib> will
-be C<undef>.
+that record, a C<tags> key which points to an arrayref, and a C<tmap>
+key which points to a hashref.
=head3 C<tags>
two more hashrefs, C<multi> and C<uni>.
The C<multi> hash holds the extracted data for tag/sub mappings which
-have the C<multiple> modifier on them. The keys in C<multi> are
-composed of the tag id and subfield code, catenated
-(e.g. C<901c>). The values are arrayrefs containing the content of all
+have the C<multiple> modifier on them. The keys in C<multi> subfield
+codes. The values are arrayrefs containing the content of all
instances of that subfield in that instance of that tag. If no tags
are defined as C<multi>, it will be C<undef>.
record struct. Oppose subfields which are not mapped, which will be
C<undef>.
-=head1 UNMAPPED TAGS
+=head3 tmap
- { tag_id => {
- sub_code => { value => VALUE, count => COUNT },
- sub_code2 => { value => VALUE, count => COUNT },
- ...
- },
- ...
- }
+A hashref, where each key (a tag id like "650") points to a listref
+containing the index (or indices) of C<tags> where that tag has
+extracted data.
+
+The intended use of this is to simplify the processing of data from
+tags which can appear more than once in a MARC record, like
+holdings. If your holdings data is in 852, C<tmap->{852}> will be a
+listref with the indices of C<tags> which hold the data from the 852
+datafields.
+
+Complimentarily, C<tmap> prevents data from singular datafields from
+having to be copied for every instance of a multiple datafield, as it
+lets you get the data from that record's one instance of whichever
+field you're looking for.
=head1 AUTHOR
projects / migration-tools.git / blobdiff