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.)

       •   doc_id - A segment document id.

INHERITANCE

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