src/record.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 #ifndef RECORD_H
  21 #define RECORD_H
  22
  23
  24 struct client;
  25 struct conf_service;
  26
  27 union data_types {
  28     struct {
  29         const char *disp;
  30         const char *norm;
  31         const char *sort;
  32         const char *snippet;
  33     } text;
  34     struct {
  35         int min;
  36         int max;
  37     } number;
  38     double fnumber;
  39 };
  40
  41
  42 struct record_metadata_attr {
  43     char *name;
  44     char *value;
  45     struct record_metadata_attr *next;
  46 };
  47
  48 struct record_metadata {
  49     union data_types data;
  50     // next item of this name
  51     struct record_metadata *next;
  52     struct record_metadata_attr *attributes;
  53 };
  54
  55 union data_types * data_types_assign(NMEM nmem,
  56                                      union data_types ** data1,
  57                                      union data_types data2);
  58
  59
  60 struct record {
  61     struct client *client;
  62     // Array mirrors list of metadata fields in config
  63     struct record_metadata **metadata;
  64     // Array mirrors list of sortkey fields in config
  65     union data_types **sortkeys;
  66     // Next in cluster of merged records
  67     struct record *next;
  68     // client result set position;
  69     int position;
  70     // score for ranking, either native or our TF/IDF, or other
  71     double score;
  72     // checksum
  73     unsigned checksum;
  74 };
  75
  76
  77 struct record * record_create(NMEM nmem, int num_metadata, int num_sortkeys,
  78                               struct client *client, int position);
  79
  80 struct record_metadata * record_metadata_create(NMEM nmem);
  81
  82 int record_compare(struct record *r1, struct record *r2, struct conf_service *service);
  83
  84 struct record_cluster
  85 {
  86     // Array mirrors list of metadata fields in config
  87     struct record_metadata **metadata;
  88     union data_types **sortkeys;
  89     // char *merge_key;
  90     struct record_metadata_attr *merge_keys;
  91
  92     int relevance_score;
  93     int *term_frequency_vec;
  94     float *term_frequency_vecf;
  95     // Set-specific ID for this record
  96     char *recid;
  97     int retrieval_position;
  98     WRBUF relevance_explain1;
  99     WRBUF relevance_explain2;
 100     struct record *records;
 101     struct record_cluster *sorted_next;
 102     struct reclist_sortparms *sort_parms;
 103 };
 104
 105 #endif // RECORD_H
 106
 107 /*
 108  * Local variables:
 109  * c-basic-offset: 4
 110  * c-file-style: "Stroustrup"
 111  * indent-tabs-mode: nil
 112  * End:
 113  * vim: shiftwidth=4 tabstop=8 expandtab
 114  */
 115