Marvin Humphrey > Lucy > Lucy::Index::SegReader

Download:
Lucy-0.4.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.004001   Source  

NAME ^

Lucy::Index::SegReader - Single-segment IndexReader.

SYNOPSIS ^

    my $polyreader = Lucy::Index::IndexReader->open(
        index => '/path/to/index',
    );
    my $seg_readers = $polyreader->seg_readers;
    for my $seg_reader (@$seg_readers) {
        my $seg_name = $seg_reader->get_seg_name;
        my $num_docs = $seg_reader->doc_max;
        print "Segment $seg_name ($num_docs documents):\n";
        my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
        for my $doc_id ( 1 .. $num_docs ) {
            my $doc = $doc_reader->fetch_doc($doc_id);
            print "  $doc_id: $doc->{title}\n";
        }
    }

DESCRIPTION ^

SegReader interprets the data within a single segment of an index.

Generally speaking, only advanced users writing subclasses which manipulate data at the segment level need to deal with the SegReader API directly.

Nearly all of SegReader's functionality is implemented by pluggable components spawned by Architecture's factory methods.

METHODS ^

get_seg_name()

Return the name of the segment.

get_seg_num()

Return the number of the segment.

INHERITANCE ^

Lucy::Index::SegReader isa Lucy::Index::IndexReader isa Lucy::Index::DataReader isa Clownfish::Obj.

syntax highlighting: