Plucene::Search::Hits.3pm

Langue: en

Autres versions - même langue

Version: 2005-09-05 (ubuntu - 08/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Plucene::Search::Hits - A list of ranked documents

SYNOPSIS

         my $hits = Plucene::Search::Hits->new;
 
         my     $doc = $hits->doc($n);
         my   $score = $hits->score($n);
         my $hit_doc = $hits->hit_doc($n);

DESCRIPTION

This is a list of ranked documents, used to hold search results.

METHODS


new

         my $hits = Plucene::Search::Hits->new;

query / searcher / filter / length / hit_docs / first / last / num_docs / max_docs

Get / set these attributes.

doc

         my $doc = $hits->doc($n);

Returns the nth document.

score

         my $score = $hits->score($n);

The score of the nth document.

hit_doc

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

Returns the nth hit document.