view release on metacpan or  search on metacpan

lib/Dezi/Result.pm  view on Meta::CPAN

package Dezi::Result;
use Moose;
use MooseX::StrictConstructor;
with 'Dezi::Role';
use Carp;
use namespace::autoclean;

our $VERSION = '0.016';

has 'doc'          => ( is => 'ro', isa => 'Object',  required => 1, );
has 'score'        => ( is => 'ro', isa => 'Num',     required => 1 );
has 'property_map' => ( is => 'ro', isa => 'HashRef', required => 1 );

=head1 NAME

Dezi::Result - abstract result class

=head1 SYNOPSIS

 my $results = $searcher->search( 'foo bar' );
 while (my $result = $results->next) {
     printf("%4d %s\n", $result->score, $result->uri);
 }

=head1 DESCRIPTION

Dezi::Result is a abstract class. It defines
the APIs that all Dezi engines adhere to in
returning results from a Dezi::InvIndex.

=head1 METHODS

The following methods are all accessors (getters) only.

=head2 doc

Returns an object for the backend engine.

=head2 score

Returns the ranking score for the Result.

=head2 uri

URL or filepath to document.

=head2 mtime

Last modified date of document.

=head2 title

Document title.

=head2 summary

Description of document.

=head2 swishdocpath

Alias for uri().

=head2 swishlastmodified

Alias for mtime().

=head2 swishtitle

Alias for title().

=head2 swishdescription