debian man page for plucene::search::hits

Plucene::Search::Hits(3pm)				User Contributed Perl Documentation				Plucene::Search::Hits(3pm)

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.

perl v5.12.4							    2011-08-14						Plucene::Search::Hits(3pm)