# Auto-generated file -- DO NOT EDIT!!!!!
=head1 NAME
KinoSearch::Index::DataReader - Abstract base class for reading index data.
=head1 DEPRECATED
The KinoSearch code base has been assimilated by the Apache L<Lucy> project.
The "KinoSearch" namespace has been deprecated, but development continues
under our new name at our new home: L<http://lucy.apache.org/>
=head1 SYNOPSIS
# Abstract base class.
=head1 DESCRIPTION
DataReader is the companion class to
L<DataWriter|KinoSearch::Index::DataWriter>. Every index component will
implement one of each.
=head1 CONSTRUCTORS
=head2 new( I<[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
);
=over
=item *
B<schema> - A Schema.
=item *
B<folder> - A Folder.
=item *
B<snapshot> - A Snapshot.
=item *
B<segments> - An array of Segments.
=item *
B<seg_tick> - The array index of the Segment object within the
C<< segments >> array that this particular DataReader is assigned
to, if any. A value of -1 indicates that no Segment should be
assigned.
=back
=head1 ABSTRACT METHODS
=head2 aggregator( I<[labeled params]> )
Create a reader which aggregates the output of several lower level
readers. Return undef if such a reader is not valid.
=over
=item *
B<readers> - An array of DataReaders.
=item *
B<offsets> - Doc id start offsets for each reader.
=back
=head1 METHODS
=head2 get_schema()
Accessor for "schema" member var.
=head2 get_folder()
Accessor for "folder" member var.
=head2 get_snapshot()
Accessor for "snapshot" member var.
=head2 get_segments()
Accessor for "segments" member var.
=head2 get_segment()
Accessor for "segment" member var.
=head2 get_seg_tick()
Accessor for "seg_tick" member var.
=head1 INHERITANCE
KinoSearch::Index::DataReader isa L<KinoSearch::Object::Obj>.
=head1 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.
=cut