Marvin Humphrey > KinoSearch > KinoSearch::Index::DataReader

Download:
KinoSearch-0.315.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  3
View/Report Bugs
Source  

NAME ^

KinoSearch::Index::DataReader - Abstract base class for reading index data.

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 ^

    # Abstract base class.

DESCRIPTION ^

DataReader is the companion class to DataWriter. Every index component will implement one of each.

CONSTRUCTORS ^

new( [labeled params] )

    my $reader = MyDataReader->new(
        schema   => $seg_reader->get_schema,      # default undef
        folder   => $seg_reader->get_folder,      # default undef
        snapshot => $seg_reader->get_snapshot,    # default undef
        segments => $seg_reader->get_segments,    # default undef
        seg_tick => $seg_reader->get_seg_tick,    # default -1
    );

ABSTRACT METHODS ^

aggregator( [labeled params] )

Create a reader which aggregates the output of several lower level readers. Return undef if such a reader is not valid.

METHODS ^

get_schema()

Accessor for "schema" member var.

get_folder()

Accessor for "folder" member var.

get_snapshot()

Accessor for "snapshot" member var.

get_segments()

Accessor for "segments" member var.

get_segment()

Accessor for "segment" member var.

get_seg_tick()

Accessor for "seg_tick" member var.

INHERITANCE ^

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.

syntax highlighting: