Marvin Humphrey > KinoSearch-0.315 > KinoSearch::Index::LexiconReader

Download:
KinoSearch-0.315.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  4
View/Report Bugs
Source  

NAME ^

KinoSearch::Index::LexiconReader - Read Lexicon 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 ^

    my $lex_reader = $seg_reader->obtain("KinoSearch::Index::LexiconReader");
    my $lexicon    = $lex_reader->lexicon( field => 'title' );

DESCRIPTION ^

LexiconReader reads term dictionary information.

ABSTRACT METHODS ^

lexicon( [labeled params] )

Return a new Lexicon for the given field. Will return undef if either the field is not indexed, or if no documents contain a value for the field.

doc_freq( [labeled params] )

Return the number of documents where the specified term is present.

INHERITANCE ^

KinoSearch::Index::LexiconReader isa 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: