Tony Bowden > Plucene > Plucene::Index::SegmentInfo

Download:
Plucene-1.25.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  5
View/Report Bugs
Source  

NAME ^

Plucene::Index::SegmentInfo - Information on a Segment

SYNOPSIS ^

        my $segment_info = Plucene::Index::SegmentInfo->new;

        # get
        my $name = $segment_info->name;
        my $doc_count = $segment_info->doc_count;
        my $dir = $segment_info->dir;

        # set
        $segment_info->name($new_name);
        $segment_info->doc_count($new_doc_count);
        $segment_info->dir($new_dir);

DESCRIPTION ^

This class holds information on a segment.

The index database is composed of 'segments' each stored in a separate file. When you add documents to the index, new segments may be created. You can compact the database and reduce the number of segments by optimizing it.

METHODS ^

name / doc_count / dir

Get / set these attributes.

syntax highlighting: