1Xapian::MatchSpy(3)   User Contributed Perl Documentation  Xapian::MatchSpy(3)
2
3
4

NAME

6       Search::Xapian::MatchSpy - abstract base class for match spies.
7

DESCRIPTION

9       This is an abstract base class for match spies in Xapian.
10
11       The subclasses will generally accumulate information seen during the
12       match, to calculate aggregate functions, or other profiles of the
13       matching documents.
14

METHODS

16       operator() <Document> <weight>
17           Virtual - needs to be implemented in extending classes. Registers a
18           document with the match spy.
19
20           This is called by the matcher once with each document seen by the
21           matcher during the match process. Note that the matcher will often
22           not see all the documents which match the query, due to
23           optimisations which allow low-weighted documents to be skipped, and
24           allow the match process to be terminated early.
25
26       get_description
27           Return a string describing this object.
28
29           This default implementation returns a generic answer, to avoid
30           forcing those deriving their own MatchSpy subclasses from having to
31           implement this (they may not care what get_description() gives for
32           their subclass).
33
34           Reimplemented in Xapian::ValueCountMatchSpy.
35
36       name
37           Return the name of this match spy.
38
39           This name is used by the remote backend. It is passed with the
40           serialised parameters to the remote server so that it knows which
41           class to create. Return the full namespace-qualified name of your
42           class here. If you don't want to support the remote backend in your
43           match spy, you can use the default implementation which simply
44           throws Xapian::UnimplementedError.
45
46           Reimplemented in Xapian::ValueCountMatchSpy.
47

SEE ALSO

49       Search::Xapian, Search::Xapian::ValueCountMatchSpy,
50       Search::Xapian::PerlMatchSpy
51
52
53
54perl v5.30.1                      2020-01-30               Xapian::MatchSpy(3)
Impressum