-/* $Id: zinfo.h,v 1.30 2006-05-10 08:13:23 adam Exp $
- Copyright (C) 1995-2005
- Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+ Copyright (C) 2004-2013 Index Data
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
for more details.
You should have received a copy of the GNU General Public License
-along with Zebra; see the file LICENSE.zebra. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
*/
YAZ_BEGIN_CDECL
+typedef enum {
+ zinfo_index_category_index,
+ zinfo_index_category_sort,
+ zinfo_index_category_alwaysmatches,
+ zinfo_index_category_anchor
+} zinfo_index_category_t;
+
+typedef ZEBRA_RES ZebraExplainUpdateFunc(void *handle,
+ Record drec,
+ data1_node *n);
+
typedef struct zebraExplainInfo *ZebraExplainInfo;
typedef struct zebDatabaseInfo ZebDatabaseInfo;
-ZebraExplainInfo zebraExplain_open (Records records, data1_handle dh,
- Res res,
- int writeFlag,
- void *updateHandle,
- int (*updateFunc)(void *handle,
- Record drec,
- data1_node *n));
-void zebraExplain_close (ZebraExplainInfo zei);
-int zebraExplain_curDatabase (ZebraExplainInfo zei, const char *database);
-int zebraExplain_newDatabase (ZebraExplainInfo zei, const char *database,
+ZebraExplainInfo zebraExplain_open(Records records, data1_handle dh,
+ Res res,
+ int writeFlag,
+ void *updateHandle,
+ ZebraExplainUpdateFunc *);
+
+void zebraExplain_close(ZebraExplainInfo zei);
+int zebraExplain_curDatabase(ZebraExplainInfo zei, const char *database);
+int zebraExplain_newDatabase(ZebraExplainInfo zei, const char *database,
int explain_database);
-int zebraExplain_lookup_attr_su(ZebraExplainInfo zei, int index_type,
- int set, int use);
-int zebraExplain_lookup_attr_su_any_index(ZebraExplainInfo zei,
- int set, int use);
int zebraExplain_add_attr_su(ZebraExplainInfo zei, int index_type,
int set, int use);
-int zebraExplain_lookup_attr_str(ZebraExplainInfo zei, int index_type,
+
+/** \brief lookup ordinal from string index + index type
+ \param zei explain info
+ \param cat category
+ \param index_type index type
+ \param str index string
+ \returns -1 no such index+type exist; ordinal otherwise
+*/
+
+int zebraExplain_lookup_attr_str(ZebraExplainInfo zei,
+ zinfo_index_category_t cat,
+ const char *index_type,
const char *str);
-int zebraExplain_add_attr_str(ZebraExplainInfo zei, int index_type,
+int zebraExplain_add_attr_str(ZebraExplainInfo zei,
+ zinfo_index_category_t cat,
+ const char *index_type,
const char *str);
-void zebraExplain_addSchema (ZebraExplainInfo zei, Odr_oid *oid);
-void zebraExplain_recordCountIncrement (ZebraExplainInfo zei, int adjust_num);
-void zebraExplain_recordBytesIncrement (ZebraExplainInfo zei, int adjust_num);
-zint zebraExplain_runNumberIncrement (ZebraExplainInfo zei, int adjust_num);
-void zebraExplain_loadAttsets (data1_handle dh, Res res);
-void zebraExplain_flush (ZebraExplainInfo zei, void *updateHandle);
+void zebraExplain_addSchema(ZebraExplainInfo zei, Odr_oid *oid);
+void zebraExplain_recordCountIncrement(ZebraExplainInfo zei, int adjust_num);
+void zebraExplain_recordBytesIncrement(ZebraExplainInfo zei, int adjust_num);
+zint zebraExplain_runNumberIncrement(ZebraExplainInfo zei, int adjust_num);
+void zebraExplain_loadAttsets(data1_handle dh, Res res);
+void zebraExplain_flush(ZebraExplainInfo zei, void *updateHandle);
+
+int zebraExplain_lookup_ord(ZebraExplainInfo zei, int ord,
+ const char **index_type, const char **db,
+ const char **string_index);
+
+int zebraExplain_ord_adjust_occurrences(ZebraExplainInfo zei, int ord,
+ int term_delta, int doc_delta);
-int zebraExplain_lookup_ord (ZebraExplainInfo zei, int ord,
- int *index_type, const char **db,
- int *set, int *use, const char **string_index);
+zint zebraExplain_ord_get_term_occurrences(ZebraExplainInfo zei, int ord);
+zint zebraExplain_ord_get_doc_occurrences(ZebraExplainInfo zei, int ord);
int zebraExplain_trav_ord(ZebraExplainInfo zei, void *handle,
- int (*f)(void *handle, int ord));
+ int (*f)(void *handle, int ord,
+ const char *index_type,
+ const char *string_index,
+ zinfo_index_category_t cat));
int zebraExplain_get_database_ord(ZebraExplainInfo zei);
int zebraExplain_removeDatabase(ZebraExplainInfo zei, void *updateHandle);
zint runNumber;
zint staticrank;
} RecordAttr;
-RecordAttr *rec_init_attr (ZebraExplainInfo zei, Record rec);
+RecordAttr *rec_init_attr(ZebraExplainInfo zei, Record rec);
YAZ_END_CDECL
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab