NAME

SWISH::Prog::Result - base result class

SYNOPSIS

 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

The following methods are all accessors (getters) only.

doc

Returns a SWISH::Prog::Doc instance.

score

Returns the ranking score for the Result.

uri

mtime

title

summary

swishdocpath

Alias for uri().

swishlastmodified

Alias for mtime().

swishtitle

Alias for title().

swishdescription

Alias for summary().

get_property( property )

Returns the stored value for property for this Result.

The default behavior is to simply call a method called property on the internal doc() object. Subclasses should implement per-engine behavior.

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:

• 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

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/

cpanm SWISH::Prog

perl -MCPAN -e shell
install SWISH::Prog