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


Plucene documentation  | view source Contained in the Plucene distribution.

Index


NAME

Top

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

SYNOPSIS

Top

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

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

DESCRIPTION

Top

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

METHODS

Top

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.


Plucene documentation  | view source Contained in the Plucene distribution.