1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * \brief Header for SortSpec parsing.
35 #include <yaz/yconfig.h>
36 #include <yaz/wrbuf.h>
37 #include <yaz/z-core.h>
41 /** \brief parse sort spec string
42 \param odr memory for result
43 \param arg sort spec string
44 \returns Z39.50 SortKeySpecList or NULL on error
46 The sort spec list is of the form:
48 where field is either a string or one or more attribute pairs
49 key=value (there must be no blanks in either field of flags).
50 flags is a character list:
52 aA< : ascending (default)
53 iI : ignoreccase / case-insensitive (default)
54 sS : respectcase / case-sensitive
55 ! : abort of key is omitted in result
56 =value : missing value
64 YAZ_EXPORT Z_SortKeySpecList *yaz_sort_spec(ODR odr, const char *arg);
66 /* \brief converts SortKeySpecList to CQL sortby string
67 \param sksl SortKeySpecList
68 \param w resulting CQL SORTBY string (of string to be appended)
72 YAZ_EXPORT int yaz_sort_spec_to_cql(Z_SortKeySpecList *sksl, WRBUF w);
74 /* \brief adds PQF type-7 sorting to existing PQF from SortKeySpecList
75 \param sksl SortKeySpecList
76 \param w original PQF (without the Type-7)
80 If successful, the pqf WRBUF holds the new PQF including the Type-7
83 YAZ_EXPORT int yaz_sort_spec_to_type7(Z_SortKeySpecList *sksl, WRBUF pqf);
85 /* \brief converts Z39.50 SortKeySpecList to SRU 1.1 sort key
86 \param sksl SortKeySpecList
87 \param w resulting sortkey will be appended to this
91 YAZ_EXPORT int yaz_sort_spec_to_srw_sortkeys(Z_SortKeySpecList *sksl, WRBUF w);
93 /* \brief converts SRU/SRW 1.1 sortkeys to Z39.50 sortspec (WRBUF)
94 \param srw_sortkeys SRU sortkeys string
95 \param w resulting Z39.50 sortspec, WRBUF string
99 YAZ_EXPORT int yaz_srw_sortkeys_to_sort_spec(const char *srw_sortkeys, WRBUF w);
101 /* \brief converts Z39.50 SortKeySpecList to Solr sort key
102 \param sksl SortKeySpecList
103 \param w resulting sortkey will be appended to this
107 YAZ_EXPORT int yaz_sort_spec_to_solr_sortkeys(Z_SortKeySpecList *sksl, WRBUF w);
109 /* \brief converts Solr sortkeys to Z39.50 sortspec (WRBUF)
110 \param srw_sortkeys Solr sortkeys string
111 \param w resulting Z39.50 sortspec, WRBUF string
115 YAZ_EXPORT int yaz_solr_sortkeys_to_sort_spec(const char *srw_sortkeys, WRBUF w);
124 * c-file-style: "Stroustrup"
125 * indent-tabs-mode: nil
127 * vim: shiftwidth=4 tabstop=8 expandtab