Marvin Humphrey > KinoSearch-0.30_04 > KinoSearch::Index::DocReader

Download:
KinoSearch-0.30_04.tar.gz

Annotate this POD

CPAN RT

Open  7
View Bugs
Report a bug
Source   Latest Release: KinoSearch-0.30_07

NAME ^

KinoSearch::Index::DocReader - Retrieve stored documents.

SYNOPSIS ^

    my $doc_reader = $seg_reader->obtain("KinoSearch::Index::DocReader");
    my $doc        = $doc_reader->fetch($doc_id);

DESCRIPTION ^

DocReader defines the interface by which documents (with all stored fields) are retrieved from the index. The default implementation returns HitDoc objects.

METHODS ^

aggregator( [labeled params] )

Returns a DocReader which divvies up requests to its sub-readers according to the offset range.

ABSTRACT METHODS ^

fetch( [labeled params] )

Returns the document identified by doc_id.

INHERITANCE ^

KinoSearch::Index::DocReader isa KinoSearch::Index::DataReader isa KinoSearch::Obj.

COPYRIGHT ^

Copyright 2005-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc. ^

See KinoSearch version 0.30.