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

    my $retval = $lexicon_reader->lexicon(
        field => $field  # required
        term  => $term   # default: undef
    );

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

    my $retval = $lexicon_reader->doc_freq(
        field => $field  # required
        term  => $term   # required
    );

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

METHODS

aggregator

    my $retval = $lexicon_reader->aggregator(
        readers => $readers  # required
        offsets => $offsets  # required
    );

Return a LexiconReader which merges the output of other LexiconReaders.

• readers - An array of LexiconReaders.

• offsets - Doc id start offsets for each reader.

INHERITANCE

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