KinoSearch::Search::Hit(3pm)

KinoSearch::Search::Hit3pm

Successful match against a query

Overview

A Hit object is a storage vessel which holds a Doc, a floating point score, and an integer document id.

Methods

get_doc

    my $doc = $hit->get_doc;

Return the Hit's KinoSearch::Document::Doc object.

get_score

    my $score = $hit->get_score;

Return the Hit's score.

get_id

    my $doc_number = $hit->get_id;

Return the Hit's document number. Note that this document number is not permanent, and will likely become invalid the next time the index is updated.

get_field_values

    my $hashref = $hit->get_field_values;

Return the values of the Hit's constituent fields as a hashref.

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.165.

From libkinosearch-perl 0.165-2 in Debian 6.0 (Squeeze). Parsed by carta from the page's man source.