NAME

MARC::File - Base class for files of MARC records

VERSION

Version 1.16

$Id: File.pm,v 1.26 2003/01/28 21:41:36 petdance Exp $

SYNOPSIS

    use MARC::File::USMARC;

    my $file = MARC::File::USMARC->in( $filename );

    while ( my $marc = $file->next() ) {
	# Do something
    }
    $file->close();
    undef $file;

EXPORT

None.

METHODS

in()

Opens a file for input.

Returns a MARC::File object, or undef on failure.

next()

Reads the next record from the file handle passed in.

Returns a MARC::Record reference, or undef on error.

skip()

Skips over the next record in the file. Same as next(), without the overhead of parsing a record you're going to throw away anyway.

Returns 1 or undef.

warnings()

Simlilar to MARC::Record and MARC::Batch, warnings() will return any warnings that have accumulated while processing this file; and as a side-effect will clear the warnings buffer.

RELATED MODULES

MARC::Record

TODO

  • out() method

    We only handle files for input right now.

LICENSE

This code may be distributed under the same terms as Perl itself.

Please note that these modules are not products of or supported by the employers of the various contributors to the code.

AUTHOR

Andy Lester, <marc@petdance.com> or <alester@flr.follett.com>