Project Lucy has retired. For details please refer to its Attic page.
Lucy::Index::DocReader – Apache Lucy Documentation
Apache Lucy™

NAME

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

SYNOPSIS

my $doc_reader = $seg_reader->obtain("Lucy::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

my $hit_doc = $doc_reader->fetch_doc($doc_id);

Retrieve the document identified by doc_id.

Returns: a HitDoc.

METHODS

aggregator

my $result = $doc_reader->aggregator(
    readers => $readers  # required
    offsets => $offsets  # required
);

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.

INHERITANCE

Lucy::Index::DocReader isa Lucy::Index::DataReader isa Clownfish::Obj.