NAME

KinoSearch::Search::Collector - Process hits.

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

# 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( KinoSearch::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

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.