File Coverage

blib/lib/WARC/Index/File/CDX/Builder.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

package WARC::Index::File::CDX::Builder;			# -*- CPerl -*-

use strict;
use warnings;

require WARC::Index::Builder;
our @ISA = qw(WARC::Index::Builder);

require WARC; *WARC::Index::File::CDX::Builder::VERSION = \$WARC::VERSION;

=head1 NAME

WARC::Index::File::CDX::Builder - build CDX WARC indexes

=head1 SYNOPSIS

  use WARC::Index;

  build WARC::Index::File::CDX into => $cdx_file, from => [@files];

  $builder = build WARC::Index::File::CDX into => $cdx_file;
  $builder->add($record);

=head1 DESCRIPTION

The C class provides the implementation
for building CDX indexes.

=head2 Options for C method when building CDX indexes

=over

=item C

Name of CDX file to write.

=item C

Array reference of CDX field letters to use, in order.  See
L for details about supported fields.

Default:  [qw/N b a m s k r M S V g u/]

=back

=cut

1;
__END__