KinoSearch::Search::Matcher - Match a set of document ids.


KinoSearch documentation  | view source Contained in the KinoSearch distribution.

Index


NAME

Top

KinoSearch::Search::Matcher - Match a set of document ids.

SYNOPSIS

Top

    # abstract base class







DESCRIPTION

Top

A Matcher iterates over a set of ascending document ids. Some Matchers implement score() and can assign relevance scores to the docs that they match. Other implementations may be match-only.

CONSTRUCTORS

Top

new()

    my $matcher = MyMatcher->SUPER::new;

Abstract constructor.

ABSTRACT METHODS

Top

next()

Proceed to the next doc id.

Returns: A positive doc id, or 0 once the iterator is exhausted.

get_doc_id()

Return the current doc id. Valid only after a successful call to next() or advance() and must not be called otherwise.

score()

Return the score of the current document.

Only Matchers which are used for scored search need implement score().

METHODS

Top

advance(target)

Advance the iterator to the first doc id greater than or equal to target. The default implementation simply calls next() over and over, but subclasses have the option of doing something more efficient.

Returns: A positive doc id, or 0 once the iterator is exhausted.

INHERITANCE

Top

KinoSearch::Search::Matcher isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE

Top


KinoSearch documentation  | view source Contained in the KinoSearch distribution.