David E. Wheeler > Lucy-0.2.2 > Lucy::Search::Collector

Download:
Lucy-0.2.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Source   Latest Release: Lucy-0.3.3

NAME ^

Lucy::Search::Collector - Process hits.

SYNOPSIS ^

    # Abstract base class.

DESCRIPTION ^

A Collector decides what to do with the hits that a Matcher iterates through, based on how the abstract collect() method is implemented.

Collectors operate on individual segments, but must operate within the context of a larger collection. Each time the collector moves to a new segment, set_reader(), set_base() and set_matcher() will be called, and the collector must take the updated information into account.

CONSTRUCTORS ^

new()

    package MyCollector;
    use base qw( Lucy::Search::Collector );
    our %foo;
    sub new {
        my $self = shift->SUPER::new;
        my %args = @_;
        $foo{$$self} = $args{foo};
        return $self;
    }

Abstract constructor. Takes no arguments.

ABSTRACT METHODS ^

collect(doc_id)

Do something with a doc id. (For instance, keep track of the docs with the ten highest scores.)

INHERITANCE ^

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

syntax highlighting: