Plucene::Index::FieldsReader.3pm

Langue: en

Autres versions - même langue

Version: 2005-09-05 (ubuntu - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

Plucene::Index::FieldsReader - read Fields in a Document

SYNOPSIS

         my $reader = Plucene::Index::FieldsReader->new(
                 $dir_name, $segment, $field_infos);
 
         my Plucene::Document $doc = $reader->doc($offset);
 
         my $size = $reader->size;
 
 

DESCRIPTION

This class gives access to documents within the index.

METHODS


new

         my $reader = Plucene::Index::FieldsReader->new(
                 $dir_name, $segment, $field_infos);
 
 

This will create a new Plucene::Index::FieldsReader with the passed in directory name, segment and field infos.

size

         my $size = $reader->size;
 
 

This returns the size.

doc

         my Plucene::Document $doc = $reader->doc($offset);
 
 

This will return the Plucene::Document object found at the passed in position.