-
-
24 Dec 2009 00:10:44 UTC
- Development release
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (68 / 0 / 15)
- Kwalitee
Bus factor: 0- License: perl_5
- Activity
24 month- Tools
- Download (809.92KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
KinoSearch::Index::DataReader - Abstract base class for reading index data.
SYNOPSIS
# Abstract base class.
DESCRIPTION
Abstract base class for reading index data.
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 );
schema - A Schema.
folder - A Folder.
snapshot - A Snapshot.
segments - An array of Segments.
seg_tick - The array index of the Segment object within the
segments
array that this particular DataReader is assigned to, if any. A value of -1 indicates that no Segment should be assigned.
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.
ABSTRACT METHODS
aggregator( [labeled params] )
Create a reader which aggregates the output of several lower level readers.
readers - An array of DataReaders.
offsets - Doc id start offsets for each reader.
INHERITANCE
KinoSearch::Index::DataReader isa KinoSearch::Obj.
COPYRIGHT AND LICENSE
Copyright 2005-2009 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.