Peter Karman > SWISH-Prog-0.70 > SWISH::Prog::Results

Download:
SWISH-Prog-0.70.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

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

NAME ^

SWISH::Prog::Results - base results class

SYNOPSIS ^

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

DESCRIPTION ^

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

METHODS ^

query

Should return the search query as it was evaluated by the Searcher.

hits

Returns the number of matching documents for the query.

next

Return the next Result.

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: