SWISH::Prog::Indexer - base indexer class

 use SWISH::Prog::Indexer;
 my $indexer = SWISH::Prog::Indexer->new(
        invindex    => SWISH::Prog::InvIndex->new,
        config      => SWISH::Prog::Config->new,
        count       => 0,
        clobber     => 1,
        flush       => 10000,
        started     => time()
 );
 $indexer->start;
 for my $doc (@list_of_docs) {
    $indexer->process($doc);
 }
 $indexer->finish;

SWISH::Prog::Indexer is a base class implementing the simplest of indexing APIs. It is intended to be subclassed, along with InvIndex, for each IR backend library.

Constructor. See the SYNOPSIS for default options.

params may include the following keys, each of which is also an accessor method:

clobber

Overrite any existing InvIndex.

config

A SWISH::Prog::Config object or file name.

flush

The number of indexed docs at which in-memory changes should be written to disk.

invindex

A SWISH::Prog::InvIndex object.

test_mode

Dry run mode, just prints info on stderr but does not build index.

Override base method to initialize object.

Opens the invindex() objet and sets the started() time to time().

doc should be a SWISH::Prog::Doc-derived object.

process() should implement whatever the particular IR library API requires.

Closes the invindex().

Returns the number of documents processed.

The time at which the Indexer object was created. Returns a Unix epoch integer.

Peter Karman, <perl@peknet.com>

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc SWISH::Prog

You can also look for information at:

* Mailing list

http://lists.swish-e.org/listinfo/users

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=SWISH-Prog

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/SWISH-Prog

* CPAN Ratings

http://cpanratings.perl.org/d/SWISH-Prog

* Search CPAN

http://search.cpan.org/dist/SWISH-Prog/

Copyright 2008-2009 by Peter Karman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

http://swish-e.org/