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


SWISH-Prog documentation  | view source Contained in the SWISH-Prog distribution.

Index


NAME

Top

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

SYNOPSIS

Top

 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

Top

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

Top

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

 TODO

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

Top

Peter Karman, <perl@peknet.com>

BUGS

Top

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

Top

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 AND LICENSE

Top

SEE ALSO

Top

http://swish-e.org/


SWISH-Prog documentation  | view source Contained in the SWISH-Prog distribution.