Marvin Humphrey > Lucy > Lucy::Search::Collector::BitCollector

Download:
Lucy-0.3.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.003003   Source  

NAME ^

Lucy::Search::Collector::BitCollector - Collector which records doc nums in a BitVector.

SYNOPSIS ^

    my $bit_vec = Lucy::Object::BitVector->new(
        capacity => $searcher->doc_max + 1,
    );
    my $bit_collector = Lucy::Search::Collector::BitCollector->new(
        bit_vector => $bit_vec, 
    );
    $searcher->collect(
        collector => $bit_collector,
        query     => $query,
    );

DESCRIPTION ^

BitCollector is a Collector which saves matching document ids in a BitVector. It is useful for recording the entire set of documents which matches a query.

CONSTRUCTORS ^

new( [labeled params] )

    my $bit_collector = Lucy::Search::Collector::BitCollector->new(
        bit_vector => $bit_vec,    # required
    );

METHODS ^

collect(doc_id)

Set bit in the object's BitVector for the supplied doc id.

INHERITANCE ^

Lucy::Search::Collector::BitCollector isa Lucy::Search::Collector isa Lucy::Object::Obj.

syntax highlighting: