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

Lucy::Search::Collector

parcel Lucy
class variable LUCY_COLLECTOR
struct symbol lucy_Collector
class nickname lucy_Coll
header file Lucy/Search/Collector.h

Name

Lucy::Search::Collector – Process hits.

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.

Functions

init
lucy_Collector*
lucy_Coll_init(
    lucy_Collector *self
);

Abstract initializer.

Methods

Collect (abstract)
void
lucy_Coll_Collect(
    lucy_Collector *self,
    int32_t 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 is a Clownfish::Obj.