1 /* $Id: rankstatic.c,v 1.3 2005-08-19 11:04:23 adam Exp $
2 Copyright (C) 1995-2005
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
35 static int log_level = 0;
36 static int log_initialized = 0;
38 struct rank_set_info {
43 * create: Creates/Initialises this rank handler. This routine is
44 * called exactly once. The routine returns the class_handle.
46 static void *create (ZebraHandle zh)
50 log_level = yaz_log_module_level("rankstatic");
53 yaz_log(log_level, "rank-static create");
58 * destroy: Destroys this rank handler. This routine is called
59 * when the handler is no longer needed - i.e. when the server
60 * dies. The class_handle was previously returned by create.
62 static void destroy (struct zebra_register *reg, void *class_handle)
64 yaz_log(log_level, "rank-static destroy");
69 * begin: Prepares beginning of "real" ranking. Called once for
70 * each result set. The returned handle is a "set handle" and
71 * will be used in each of the handlers below.
73 static void *begin (struct zebra_register *reg,
74 void *class_handle, RSET rset, NMEM nmem,
75 TERMID *terms, int numterms)
77 struct rank_set_info *si =
78 (struct rank_set_info *) nmem_malloc (nmem, sizeof(*si));
81 yaz_log(log_level, "rank-static begin");
82 /* count how many terms are ranked (2=102 or similar) */
83 si->no_rank_entries = 0;
84 for (i = 0; i < numterms; i++)
86 yaz_log(log_level, "i=%d flags=%s '%s'", i,
87 terms[i]->flags, terms[i]->name );
88 if (!strncmp (terms[i]->flags, "rank,", 5))
89 (si->no_rank_entries)++;
95 * end: Terminates ranking process. Called after a result set
98 static void end (struct zebra_register *reg, void *set_handle)
100 yaz_log(log_level, "rank-static end");
105 * add: Called for each word occurence in a result set. This routine
106 * should be as fast as possible. This routine should "incrementally"
109 static void add (void *set_handle, int seqno, TERMID term)
114 * calc: Called for each document in a result. This handler should
115 * produce a score based on previous call(s) to the add handler. The
116 * score should be between 0 and 1000. If score cannot be obtained
117 * -1 should be returned.
119 static int calc (void *set_handle, zint sysno, zint staticrank,
122 struct rank_set_info *si = (struct rank_set_info *) set_handle;
124 if (!si->no_rank_entries)
125 return -1; /* ranking not enabled for any terms */
127 /* if we set *stop_flag = 1, we stop processing (of result set list) */
128 /* staticrank = 0 is highest, MAXINT lowest */
129 return INT_MAX - staticrank; /* but score is reverse (logical) */
133 * Pseudo-meta code with sequence of calls as they occur in a
134 * server. Handlers are prefixed by --:
150 static struct rank_control rank_control = {
160 struct rank_control *rank_static_class = &rank_control;