Dezi::InvIndex - base class for Dezi inverted indexes
use Dezi::InvIndex; my $index = Dezi::InvIndex->new(path => 'path/to/index'); print $index; # prints $index->path my $header = $index->get_header(); # $meta isa Dezi::InvIndex::Header object
A Dezi::InvIndex is a base class for defining different inverted index formats.
Constructor.
Instantiates an InvIndex object in the correct subclass based on the Index Format in the InvIndex header file.
Example:
my $invindex = Dezi::InvIndex->new('path/to/lucy.index'); # $invindex isa Dezi::Lucy::InvIndex
Returns a Path::Class::Dir object representing the directory path to the index. The path is a directory which contains the various files that comprise the index.
Returns a Dezi::InvIndex::Header object with which you can query information about the index.
Returns Path::Class::File object pointing at the header_file.
Open the invindex for reading/writing. Subclasses should implement this per their IR library specifics.
This base open() method will rmtree( path() ) if clobber() is true, and will mkpath() if path() does not exist. So SUPER::open() should do something sane at minimum.
Open the invindex in read-only mode. This is typical when searching the invindex.
The default open_ro() method will simply call through to open().
Close the index. Subclasses should implement this per their IR library specifics.
Get/set the Boolean indicating whether the index should overwrite any existing index with the same name. The default is true.
Returns a new instance like new() does, blessed into the appropriate class indicated by the swish.xml meta header file.
swish.xml
Peter Karman, <karpet@dezi.org>
Please report any bugs or feature requests to bug-dezi-app at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi-App. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-dezi-app at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Dezi::InvIndex
You can also look for information at:
Website
http://dezi.org/
IRC
#dezisearch at freenode
Mailing list
https://groups.google.com/forum/#!forum/dezi-search
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dezi-App
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Dezi-App
CPAN Ratings
http://cpanratings.perl.org/d/Dezi-App
Search CPAN
https://metacpan.org/dist/Dezi-App/
Copyright 2018 by Peter Karman
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
http://dezi.org/, http://swish-e.org/, http://lucy.apache.org/
To install Dezi::App, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dezi::App
CPAN shell
perl -MCPAN -e shell install Dezi::App
For more information on module installation, please visit the detailed CPAN module installation guide.