Nick Wellnhofer > Lucy-0.5.1 > Lucy::Index::PostingListReader

Download:
Lucy-0.5.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.005001   Source  

NAME ^

Lucy::Index::PostingListReader - Read postings data.

SYNOPSIS ^

    my $posting_list_reader 
        = $seg_reader->obtain("Lucy::Index::PostingListReader");
    my $posting_list = $posting_list_reader->posting_list(
        field => 'title', 
        term  => 'foo',
    );

DESCRIPTION ^

PostingListReaders produce PostingList objects which convey document matching information.

ABSTRACT METHODS ^

posting_list

    my $posting_list = $posting_list_reader->posting_list(
        field => $field  # default: undef
        term  => $term   # default: undef
    );

Returns a PostingList, or undef if either field is undef or field is not present in any documents.

METHODS ^

aggregator

    my $result = $posting_list_reader->aggregator(
        readers => $readers  # required
        offsets => $offsets  # required
    );

Returns undef since PostingLists may only be iterated at the segment level.

INHERITANCE ^

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

syntax highlighting: