Peter Karman > SWISH-Prog-0.74 > SWISH::Prog::Searcher

Download:
SWISH-Prog-0.74.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.74   Source   Latest Release: SWISH-Prog-0.75

NAME ^

SWISH::Prog::Searcher - base searcher class

SYNOPSIS ^

 my $searcher = SWISH::Prog::Searcher->new(
                    invindex        => 'path/to/index',
                    max_hits        => 1000,
                );
                
 my $results = $searcher->search( 'foo bar' );
 while (my $result = $results->next) {
     printf("%4d %s\n", $result->score, $result->uri);
 }

DESCRIPTION ^

SWISH::Prog::Searcher is a base searcher class. It defines the APIs that all SWISH::Prog storage backends adhere to in returning results from a SWISH::Prog::InvIndex.

METHODS ^

init

Overrides base method.

invindex

A SWISH::Prog::InvIndex object or directory path. Required. Set in new().

May be a single value or an array ref of values (for searching multiple indexes at once).

max_hits

The maximum number of hits to return. Optional. Default is 1000.

qp_config

Optional hashref passed to Search::Query::Parser->new().

search( query )

Returns a SWISH::Prog::Results object.

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: