File Coverage

blib/lib/WARC/Index/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::Builder;					# -*- CPerl -*-

use strict;
use warnings;

our @ISA = qw();

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

=head1 NAME

WARC::Index::Builder - abstract base class for building indexes

=head1 SYNOPSIS

  use WARC::Index;

  $cdx_builder = build WARC::Index::File::CDX (...);
  $sdbm_builder = build WARC::Index::File::SDBM (...);

  $cdx_entry = $cdx_builder->add($record);
  $sdbm_builder->add($cdx_entry);

=head1 DESCRIPTION

C is an abstract base class for constructing indexes
on WARC files.  The interface is documented here, but implemented in
specialized classes for each index type.

=head2 Methods

=over

=item $entry = $builder-Eadd( ... )

Add an item to the growing index.  All index types accept both WARC records
and entries from other indexes, although only metaindex-capable formats use
the latter.  Any number of items may be added with a single call.

Returns the new index entry.

=back

=cut

1;
__END__