1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 Index Data
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
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
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
20 #ifndef PAZPAR2_CONFIG_H
21 #define PAZPAR2_CONFIG_H
23 #include <libxslt/xslt.h>
24 #include <libxslt/transform.h>
25 #include <libxslt/xsltutils.h>
30 enum conf_metadata_type {
31 Metadata_type_generic, // Generic text field
32 Metadata_type_number, // A number
33 Metadata_type_year, // A number
34 Metadata_type_date // A number
37 enum conf_metadata_merge {
38 Metadata_merge_no, // Don't merge
39 Metadata_merge_unique, // Include unique elements in merged block
40 Metadata_merge_longest, // Include the longest (strlen) value
41 Metadata_merge_range, // Store value as a range of lowest-highest
42 Metadata_merge_all // Just include all elements found
45 enum conf_sortkey_type {
46 Metadata_sortkey_relevance,
47 Metadata_sortkey_numeric, // Standard numerical sorting
48 Metadata_sortkey_skiparticle, // Skip leading article when sorting
49 Metadata_sortkey_string // Flat string
52 // This controls the ability to insert 'static' values from settings into retrieval recs
53 enum conf_setting_type {
55 Metadata_setting_postproc, // Insert setting value into normalized record
56 Metadata_setting_parameter // Expose value to normalization stylesheets
59 // Describes known metadata elements and how they are to be manipulated
60 // An array of these structure provides a 'map' against which
61 // discovered metadata elements are matched. It also governs storage,
62 // to minimize number of cycles needed at various tages of processing
65 char *name; // The field name. Output by normalization stylesheet
66 int brief; // Is this element to be returned in the brief format?
67 int termlist;// Is this field to be treated as a termlist for browsing?
68 int rank; // Rank factor. 0 means don't use this field for ranking,
70 // values >1 give additional significance to a field
71 int sortkey_offset; // -1 if it's not a sortkey, otherwise index
72 // into service/record_cluster->sortkey array
73 enum conf_metadata_type type;
74 enum conf_metadata_merge merge;
75 enum conf_setting_type setting; // Value is to be taken from session/db settings?
80 struct conf_metadata * conf_metadata_assign(NMEM nmem,
81 struct conf_metadata * metadata,
83 enum conf_metadata_type type,
84 enum conf_metadata_merge merge,
85 enum conf_setting_type setting,
97 enum conf_sortkey_type type;
100 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
101 struct conf_sortkey * sortkey,
103 enum conf_sortkey_type type);
107 // It is conceivable that there will eventually be several 'services'
108 // offered from one server, with separate configuration -- possibly
109 // more than one services associated with the same port. For now,
110 // however, only a single service is possible.
114 struct conf_metadata *metadata;
116 struct conf_sortkey *sortkeys;
120 struct conf_service * conf_service_create(NMEM nmem,
121 int num_metadata, int num_sortkeys);
124 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
125 struct conf_service *service,
128 enum conf_metadata_type type,
129 enum conf_metadata_merge merge,
130 enum conf_setting_type setting,
136 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
137 struct conf_service *service,
140 enum conf_sortkey_type type);
143 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
145 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
157 pp2_charset_t relevance_pct;
158 pp2_charset_t sort_pct;
159 pp2_charset_t mergekey_pct;
161 struct conf_service *service;
162 struct conf_server *next;
165 struct conf_targetprofiles
175 struct conf_server *servers;
176 struct conf_targetprofiles *targetprofiles;
179 #ifndef CONFIG_NOEXTERNS
181 extern struct conf_config *config;
185 int read_config(const char *fname);
186 xsltStylesheet *conf_load_stylesheet(const char *fname);
193 * indent-tabs-mode: nil
195 * vim: shiftwidth=4 tabstop=8 expandtab