NAME

Search::Kinosearch::Kindex - A Kinosearch index

DEPRECATED

Search::Kinosearch has been superseded by KinoSearch. Please use the new version.

SYNOPSIS

    my $kindex = Search::Kinosearch::Kindex->new();

DESCRIPTION

A Kindex object is the logical representation of a kindex created by Search::Kinosearch::Kindexer.

METHODS

new()

    my $kindex = Search::Kinosearch::Kindex->new(
        -mainpath      => '/foo/bar/kindex', # default: ./kindex
        -freqpath      => '/baz/freqdata'    # default: ./kindex/freqdata 
        );

Construct a Kindex object.

Kindex objects on their own are useless, so there is only one reason that you would ever do this: to create a persistent Kindex object under mod_perl that you can feed to multiple KSearch objects. Loading all your Kinosearch modules *and* creating a Kindex object (which involves opening a bunch of files, tying hashes, etc) when Apache starts cuts down somewhat on search-time overhead.

Be advised that creating a persistent Kindex object establishes a read lock on the kindex (specifically, on a file called 'kinoreadlock'). You can start a Kindexer process while this read lock is in place, but it must be released before you write_kindex().

-mainpath

The location of your kindex.

-freqpath

The directory containing certain files which are crucial to search time performance. By default, this is a directory called 'freqdata' within whatever you specified as -mainpath.

SEE ALSO

• Search::Kinosearch

• Search::Kinosearch::Kindexer

• Search::Kinosearch::KSearch

• Search::Kinosearch::Tutorial

• Search::Kinosearch::Lingua

AUTHOR

Marvin Humphrey <marvin at rectangular dot com>

COPYRIGHT

Copyright (c) 2005 Marvin Humphrey. All rights reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.