1MARC::Batch(3)        User Contributed Perl Documentation       MARC::Batch(3)
2
3
4

NAME

6       MARC::Batch - Perl module for handling files of MARC::Record objects
7

SYNOPSIS

9       MARC::Batch hides all the file handling of files of "MARC::Record"s.
10       "MARC::Record" still does the file I/O, but "MARC::Batch" handles the
11       multiple-file aspects.
12
13           use MARC::Batch;
14
15           my $batch = MARC::Batch->new( 'USMARC', @files );
16           while ( my $marc = $batch->next ) {
17               print $marc->subfield(245,"a"), "\n";
18           }
19

EXPORT

21       None.  Everything is a class method.
22

METHODS

24   new( $type, @files )
25       Create a "MARC::Batch" object that will process @files.
26
27       $type must be either "USMARC" or "MicroLIF".  If you want to specify
28       "MARC::File::USMARC" or "MARC::File::MicroLIF", that's OK, too. "new()"
29       returns a new MARC::Batch object.
30
31       @files can be a list of filenames:
32
33           my $batch = MARC::Batch->new( 'USMARC', 'file1.marc', 'file2.marc' );
34
35       Your @files may also contain filehandles. So if you've got a large file
36       that's gzipped you can open a pipe to gzip and pass it in:
37
38           my $fh = IO::File->new( 'gunzip -c marc.dat.gz |' );
39           my $batch = MARC::Batch->new( 'USMARC', $fh );
40
41       And you can mix and match if you really want to:
42
43           my $batch = MARC::Batch->new( 'USMARC', $fh, 'file1.marc' );
44
45   next()
46       Read the next record from that batch, and return it as a MARC::Record
47       object.  If the current file is at EOF, close it and open the next one.
48       "next()" will return "undef" when there is no more data to be read from
49       any batch files.
50
51       By default, "next()" also will return "undef" if an error is
52       encountered while reading from the batch. If not checked for this can
53       cause your iteration to terminate prematurely. To alter this behavior,
54       see "strict_off()". You can retrieve warning messages using the
55       "warnings()" method.
56
57       Optionally you can pass in a filter function as a subroutine reference
58       if you are only interested in particular fields from the record. This
59       can boost performance.
60
61   strict_off()
62       If you would like "MARC::Batch" to continue after it has encountered
63       what it believes to be bad MARC data then use this method to turn
64       strict OFF.  A call to "strict_off()" always returns true (1).
65
66       "strict_off()" can be handy when you don't care about the quality of
67       your MARC data, and just want to plow through it. For safety,
68       "MARC::Batch" strict is ON by default.
69
70   strict_on()
71       The opposite of "strict_off()", and the default state. You shouldn't
72       have to use this method unless you've previously used "strict_off()",
73       and want it back on again.  When strict is ON calls to next() will
74       return undef when an error is encountered while reading MARC data.
75       strict_on() always returns true (1).
76
77   warnings()
78       Returns a list of warnings that have accumulated while processing a
79       particular batch file. As a side effect the warning buffer will be
80       cleared.
81
82           my @warnings = $batch->warnings();
83
84       This method is also used internally to set warnings, so you probably
85       don't want to be passing in anything as this will set warnings on your
86       batch object.
87
88       "warnings()" will return the empty list when there are no warnings.
89
90   warnings_off()
91       Turns off the default behavior of printing warnings to STDERR. However,
92       even with warnings off the messages can still be retrieved using the
93       warnings() method if you wish to check for them.
94
95       "warnings_off()" always returns true (1).
96
97   warnings_on()
98       Turns on warnings so that diagnostic information is printed to STDERR.
99       This is on by default so you shouldn't have to use it unless you've
100       previously turned off warnings using warnings_off().
101
102       warnings_on() always returns true (1).
103
104   filename()
105       Returns the currently open filename or "undef" if there is not
106       currently a file open on this batch object.
107

109       MARC::Record, MARC::Lint
110

TODO

112       None yet.  Send me your ideas and needs.
113

LICENSE

115       This code may be distributed under the same terms as Perl itself.
116
117       Please note that these modules are not products of or supported by the
118       employers of the various contributors to the code.
119

AUTHOR

121       Andy Lester, "<andy@petdance.com>"
122
123
124
125perl v5.12.0                      2005-04-27                    MARC::Batch(3)
Impressum