Plucene::Index::SegmentInfos.3pm

Langue: en

Autres versions - même langue

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

Section: 3 (Bibliothèques de fonctions)

NAME

Plucene::Index::SegmentInfos - A collection of SegmentInfo objects

SYNOPSIS

         my $segmentinfos = Plucene::Index::SegmentInfos->new;
 
         $segmentinfos->read($dir);
         $segmentinfos->write($dir);
 
         $segmentinfos->add_element(Plucene::Index::SegmentInfo $segment_info);
 
         my Plucene::Index::SegmentInfo @segment_info 
                 = $segmentinfos->segments;
 
 

DESCRIPTION

This is a collection of Plucene::Index::SegmentInfo objects

METHODS


new

         my $segmentinfos = Plucene::Index::SegmentInfos->new;
 
 

This will create a new (empty) Plucene::Index::SegmentInfos object.

read

         $segmentinfos->read($dir);
 
 

This will read the segments file from the passed directory.

write

         $segmentinfos->write($dir);
 
 

This will write the segments info file out.

add_element

         $segmentinfos->add_element(Plucene::Index::SegmentInfo $segment_info);
 
 

This will add the passed Plucene::Index::SegmentInfo object..

info

         my Plucene::Index::SegmentInfo $info 
                 = $segmentinfos->info($segment_no);
 
 

This will return the Plucene::Index::SegmentInfo object at the passed segment number.

segments

         my Plucene::Index::SegmentInfo @segment_info 
                 = $segmentinfos->segments;
 
 

This returns all the Plucene::Index::SegmentInfo onjects in this segment.