Nick Wellnhofer > Lucy > Lucy::Search::Hits

Download:
Lucy-0.5.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.005001   Source  

NAME ^

Lucy::Search::Hits - Access search results.

SYNOPSIS ^

    my $hits = $searcher->hits(
        query      => $query,
        offset     => 0,
        num_wanted => 10,
    );
    while ( my $hit = $hits->next ) {
        print "<p>$hit->{title} <em>" . $hit->get_score . "</em></p>\n";
    }

DESCRIPTION ^

Hits objects are iterators used to access the results of a search.

METHODS ^

next

    my $hit_doc = $hits->next();

Return the next hit, or undef when the iterator is exhausted.

total_hits

    my $int = $hits->total_hits();

Return the total number of documents which matched the Query used to produce the Hits object. Note that this is the total number of matches, not just the number of matches represented by the Hits iterator.

INHERITANCE ^

Lucy::Search::Hits isa Clownfish::Obj.

syntax highlighting: