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(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.

       •   readers - An array of DocReaders.

       •   offsets - Doc id start offsets for each reader.

INHERITANCE

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