src/record.h

   1 /* $Id: record.h,v 1.11 2007-07-16 17:01:46 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     char *text;
  32     struct {
  33         int min;
  34         int max;
  35     } number;
  36 };
  37
  38
  39
  40 struct record_metadata {
  41     union data_types data;
  42     // next item of this name
  43     struct record_metadata *next;
  44 };
  45
  46 union data_types * data_types_assign(NMEM nmem,
  47                                      union data_types ** data1,
  48                                      union data_types data2);
  49
  50
  51 struct record {
  52     struct client *client;
  53     // Array mirrors list of metadata fields in config
  54     struct record_metadata **metadata;
  55     // Array mirrors list of sortkey fields in config
  56     union data_types **sortkeys;
  57     // Next in cluster of merged records
  58     struct record *next;
  59     // client result set position;
  60     int position;
  61 };
  62
  63
  64 struct record * record_create(NMEM nmem, int num_metadata, int num_sortkeys,
  65                               struct client *client, int position);
  66
  67 struct record_metadata * record_metadata_create(NMEM nmem);
  68
  69 struct record_metadata * record_metadata_insert(NMEM nmem,
  70                                                 struct record_metadata ** rmd,
  71                                                 union data_types data);
  72
  73
  74 struct record_metadata * record_add_metadata_field_id(NMEM nmem,
  75                                                       struct record * record,
  76                                                       int field_id,
  77                                                       union data_types data);
  78
  79
  80 struct record_metadata * record_add_metadata(NMEM nmem,
  81                                              struct record * record,
  82                                              struct conf_service * service,
  83                                              const char * name,
  84                                              union data_types data);
  85
  86
  87 union data_types * record_assign_sortkey_field_id(NMEM nmem,
  88                                                struct record * record,
  89                                                int field_id,
  90                                                union data_types data);
  91
  92
  93 union data_types * record_assign_sortkey(NMEM nmem,
  94                                       struct record * record,
  95                                       struct conf_service * service,
  96                                       const char * name,
  97                                       union data_types data);
  98
  99
 100
 101
 102 struct record_cluster
 103 {
 104     // Array mirrors list of metadata fields in config
 105     struct record_metadata **metadata;
 106     union data_types **sortkeys;
 107     char *merge_key;
 108     int relevance;
 109     int *term_frequency_vec;
 110     // Set-specific ID for this record
 111     char *recid;
 112     struct record *records;
 113 };
 114
 115
 116
 117
 118 #endif // RECORD_H
 119
 120 /*
 121  * Local variables:
 122  * c-basic-offset: 4
 123  * indent-tabs-mode: nil
 124  * End:
 125  * vim: shiftwidth=4 tabstop=8 expandtab
 126  */