Marvin Humphrey > KinoSearch > KinoSearch::Index::DocReader

Download:
KinoSearch-0.315.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  4
View/Report Bugs
Source  

NAME ^

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

DEPRECATED ^

The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home: http://lucy.apache.org/

SYNOPSIS ^

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

ABSTRACT METHODS ^

fetch_doc(doc_id)

Retrieve the document identified by doc_id.

Returns: a HitDoc.

METHODS ^

aggregator( [labeled params] )

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

INHERITANCE ^

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

COPYRIGHT AND LICENSE ^

Copyright 2005-2011 Marvin Humphrey

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

syntax highlighting: