Marvin Humphrey > KinoSearch-0.315 > KinoSearch::Search::Collector::BitCollector

Download:
KinoSearch-0.315.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  4
View/Report Bugs
Source  

NAME ^

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

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 $bit_vec = KinoSearch::Object::BitVector->new(
        capacity => $searcher->doc_max + 1,
    );
    my $bit_collector = KinoSearch::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 = KinoSearch::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 ^

KinoSearch::Search::Collector::BitCollector isa KinoSearch::Search::Collector 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: