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

Download:
SWISH-Prog-Lucy-0.23.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.23   Source  

NAME ^

SWISH::Prog::Lucy::Results - search results for Swish3 Lucy backend

SYNOPSIS ^

  my $results = $searcher->search($query);
  $results->find_relevant_fields(1);
  while ( my $result = $results->next ) {
      my $fields = $result->relevant_fields;
      for my $f (@$fields) {
          printf("%s matched %s\n", $result->uri, $f);
      }
  }

DESCRIPTION ^

SWISH::Prog::Lucy::Results is an Apache Lucy based Results class for Swish3.

METHODS ^

Only new and overridden methods are documented here. See the SWISH::Prog::Results documentation.

find_relevant_fields 1|0

Set to true (1) to locate the fields the query matched for each result. Default is false (0).

NOTE that the Indexer must have had highlightable_fields set to true (1) in order for find_relevant_fields to work.

next

Returns the next SWISH::Prog::Lucy::Result object from the result set.

lucy_hits

Get the internal Lucy::Search::Hits object.

property_map

Get the read-only hashref of PropertyNameAlias to PropertyName values.

id

Get the read-only unique id from the parent Searcher.

AUTHOR ^

Peter Karman, <karman at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-swish-prog-lucy at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog-Lucy. 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::Lucy

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2009 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: