Project Lucy has retired. For details please refer to its Attic page.
Lucy::Search::Collector – Apache Lucy Documentation
Apache Lucy™

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

$collector->collect($doc_id);

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

  • doc_id - A segment document id.

INHERITANCE

Lucy::Search::Collector isa Clownfish::Obj.