NAME¶

Lucy::Index::LexiconReader - Read Lexicon data.

SYNOPSIS¶

    my $lex_reader = $seg_reader->obtain("Lucy::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.

•

field - Field name.

•

term - Pre-locate the Lexicon to this term.

doc_freq( [labeled params] )¶

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

INHERITANCE¶

Lucy::Index::LexiconReader isa Lucy::Index::DataReader isa Lucy::Object::Obj.