Peter Karman > SWISH-Prog-0.75 > SWISH::Prog::Aggregator::FS

Download:
SWISH-Prog-0.75.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.75   Source  

NAME ^

SWISH::Prog::Aggregator::FS - crawl a filesystem

SYNOPSIS ^

 use SWISH::Prog::Aggregator::FS;
 my $fs = SWISH::Prog::Aggregator::FS->new(
        indexer => SWISH::Prog::Indexer->new
    );
    
 $fs->indexer->start;
 $fs->crawl( $path );
 $fs->indexer->finish;

DESCRIPTION ^

SWISH::Prog::Aggregator::FS is a filesystem aggregator implementation of the SWISH::Prog::Aggregator API. It is similar to the DirTree.pl script in the Swish-e 2.4 distribution.

METHODS ^

See SWISH::Prog::Aggregator.

init

Implements the base init() method called by new().

file_ok( full_path )

Check full_path before fetch()ing it.

Returns 0 if full_path should be skipped.

Returns file extension of full_path if full_path should be processed.

dir_ok( directory )

Called by find() for all directories. You can control the recursion into directory via the config() params

get_doc( file_path [, stat, ext ] )

Returns a doc_class() instance representing file_path.

crawl( paths_or_files )

Crawl the filesystem recursively within paths_or_files, processing each document specified by the config().

AUTHOR ^

Peter Karman, <perl@peknet.com>

BUGS ^

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.

SUPPORT ^

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

    perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE ^

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.

SEE ALSO ^

http://swish-e.org/

syntax highlighting: