NAME
KinoSearch::Search::Matcher - Match a set of document ids.
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 classDESCRIPTION
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
new()
my $matcher = MyMatcher->SUPER::new;Abstract constructor.
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().
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.
INHERITANCE
KinoSearch::Search::Matcher 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.