src/record.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2013 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 *sort;
  31         const char *snippet;
  32     } text;
  33     struct {
  34         int min;
  35         int max;
  36     } number;
  37 };
  38
  39
  40 struct record_metadata_attr {
  41     char *name;
  42     char *value;
  43     struct record_metadata_attr *next;
  44 };
  45
  46 struct record_metadata {
  47     union data_types data;
  48     // next item of this name
  49     struct record_metadata *next;
  50     struct record_metadata_attr *attributes;
  51 };
  52
  53 union data_types * data_types_assign(NMEM nmem,
  54                                      union data_types ** data1,
  55                                      union data_types data2);
  56
  57
  58 struct record {
  59     struct client *client;
  60     // Array mirrors list of metadata fields in config
  61     struct record_metadata **metadata;
  62     // Array mirrors list of sortkey fields in config
  63     union data_types **sortkeys;
  64     // Next in cluster of merged records
  65     struct record *next;
  66     // client result set position;
  67     int position;
  68     // checksum
  69     unsigned checksum;
  70 };
  71
  72
  73 struct record * record_create(NMEM nmem, int num_metadata, int num_sortkeys,
  74                               struct client *client, int position);
  75
  76 struct record_metadata * record_metadata_create(NMEM nmem);
  77
  78 int record_compare(struct record *r1, struct record *r2, struct conf_service *service);
  79
  80 struct record_cluster
  81 {
  82     // Array mirrors list of metadata fields in config
  83     struct record_metadata **metadata;
  84     union data_types **sortkeys;
  85     // char *merge_key;
  86     struct record_metadata_attr *merge_keys;
  87
  88     int relevance_score;
  89     int *term_frequency_vec;
  90     float *term_frequency_vecf;
  91     // Set-specific ID for this record
  92     char *recid;
  93     WRBUF relevance_explain1;
  94     WRBUF relevance_explain2;
  95     struct record *records;
  96     struct record_cluster *sorted_next;
  97     struct reclist_sortparms *sort_parms;
  98 };
  99
 100 #endif // RECORD_H
 101
 102 /*
 103  * Local variables:
 104  * c-basic-offset: 4
 105  * c-file-style: "Stroustrup"
 106  * indent-tabs-mode: nil
 107  * End:
 108  * vim: shiftwidth=4 tabstop=8 expandtab
 109  */
 110