• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
  • new()
• METHODS
  • advance(target)
• ABSTRACT METHODS
  • next()
  • get_doc_id()
  • score()
• INHERITANCE
• COPYRIGHT
• LICENSE, DISCLAIMER, BUGS, etc.

NAME

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

SYNOPSIS

    # Matcher is an abstract base class -- see MockScorer for an example
    # implementation.

DESCRIPTION

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

CONSTRUCTORS

new()

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

Abstract constructor.

METHODS

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.

• target - A positive doc id, which must be greater than the current doc id once the iterator has been initialized.

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

ABSTRACT METHODS

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

INHERITANCE

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

COPYRIGHT

Copyright 2005-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.30.