NAME

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

DEPRECATED

The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home: http://lucy.apache.org/

SYNOPSIS

my $polyreader = KinoSearch::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("KinoSearch::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

KinoSearch::Index::SegReader isa KinoSearch::Index::IndexReader isa KinoSearch::Index::DataReader isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE

Copyright 2005-2011 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.