src/record.h

   1 /* $Id: record.h,v 1.12 2007-09-10 16:25:50 adam Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 #ifndef RECORD_H
  23 #define RECORD_H
  24
  25
  26 struct record;
  27 struct client;
  28 struct conf_service;
  29
  30 union data_types {
  31     struct {
  32         const char *disp;
  33         const char *sort;
  34     } text;
  35     struct {
  36         int min;
  37         int max;
  38     } number;
  39 };
  40
  41
  42
  43 struct record_metadata {
  44     union data_types data;
  45     // next item of this name
  46     struct record_metadata *next;
  47 };
  48
  49 union data_types * data_types_assign(NMEM nmem,
  50                                      union data_types ** data1,
  51                                      union data_types data2);
  52
  53
  54 struct record {
  55     struct client *client;
  56     // Array mirrors list of metadata fields in config
  57     struct record_metadata **metadata;
  58     // Array mirrors list of sortkey fields in config
  59     union data_types **sortkeys;
  60     // Next in cluster of merged records
  61     struct record *next;
  62     // client result set position;
  63     int position;
  64 };
  65
  66
  67 struct record * record_create(NMEM nmem, int num_metadata, int num_sortkeys,
  68                               struct client *client, int position);
  69
  70 struct record_metadata * record_metadata_create(NMEM nmem);
  71
  72 struct record_metadata * record_metadata_insert(NMEM nmem,
  73                                                 struct record_metadata ** rmd,
  74                                                 union data_types data);
  75
  76
  77 struct record_metadata * record_add_metadata_field_id(NMEM nmem,
  78                                                       struct record * record,
  79                                                       int field_id,
  80                                                       union data_types data);
  81
  82
  83 struct record_metadata * record_add_metadata(NMEM nmem,
  84                                              struct record * record,
  85                                              struct conf_service * service,
  86                                              const char * name,
  87                                              union data_types data);
  88
  89
  90 union data_types * record_assign_sortkey_field_id(NMEM nmem,
  91                                                struct record * record,
  92                                                int field_id,
  93                                                union data_types data);
  94
  95
  96 union data_types * record_assign_sortkey(NMEM nmem,
  97                                       struct record * record,
  98                                       struct conf_service * service,
  99                                       const char * name,
 100                                       union data_types data);
 101
 102
 103
 104
 105 struct record_cluster
 106 {
 107     // Array mirrors list of metadata fields in config
 108     struct record_metadata **metadata;
 109     union data_types **sortkeys;
 110     char *merge_key;
 111     int relevance;
 112     int *term_frequency_vec;
 113     // Set-specific ID for this record
 114     char *recid;
 115     struct record *records;
 116 };
 117
 118
 119
 120
 121 #endif // RECORD_H
 122
 123 /*
 124  * Local variables:
 125  * c-basic-offset: 4
 126  * indent-tabs-mode: nil
 127  * End:
 128  * vim: shiftwidth=4 tabstop=8 expandtab
 129  */