Author image Marvin Humphrey
and 1 contributors

NAME

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

SYNOPSIS

    my $doc_reader = $seg_reader->obtain("KinoSearch::Index::DocReader");
    my $doc        = $doc_reader->fetch( doc_id => $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.

  • readers - An array of DocReaders.

  • offsets - Doc id start offsets for each reader.

ABSTRACT METHODS

fetch( [labeled params] )

Returns the document identified by doc_id.

INHERITANCE

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

COPYRIGHT AND LICENSE

Copyright 2005-2010 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.