X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fretrieval.h;h=f71f32f30167380e51e8c7bce6a5615e90c65f5b;hp=a0426e779e07bc5e02be0ee0165a45e47b951a78;hb=a3e65bcd3250b107397675bc65b35b5939355025;hpb=5008c98db7e9ca6291347b6ecddb946aff92d0fe diff --git a/include/yaz/retrieval.h b/include/yaz/retrieval.h index a0426e7..f71f32f 100644 --- a/include/yaz/retrieval.h +++ b/include/yaz/retrieval.h @@ -1,30 +1,30 @@ -/* - * Copyright (C) 2005-2006, Index Data ApS - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2012 Index Data. + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Id: retrieval.h,v 1.5 2006-05-09 13:39:46 adam Exp $ + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + /** * \file retrieval.h * \brief Retrieval Utility @@ -36,7 +36,7 @@ #include #include #include - +#include #include YAZ_BEGIN_CDECL @@ -54,36 +54,56 @@ YAZ_EXPORT yaz_retrieval_t yaz_retrieval_create(void); */ YAZ_EXPORT void yaz_retrieval_destroy(yaz_retrieval_t p); +#if YAZ_HAVE_XML2 /** configures retrieval \param p retrieval handle \param node xmlNode pointer (root element of XML config) \retval 0 success \retval -1 failure - On failure, use yaz_retrieval_get_error to get error string. + On failure, call yaz_retrieval_get_error to get error string. For retrieval: \verbatim - - - MARCXML - - - - - + + + + + + + + + + + + + - + \endverbatim */ YAZ_EXPORT -int yaz_retrieval_configure(yaz_retrieval_t p, const void *node); +int yaz_retrieval_configure(yaz_retrieval_t p, const xmlNode *node); +/** configures retrieval with user-defined conversion types + \param p retrieval handle + \param node xmlNode pointer (root element of XML config) + \param types record conversion types + \retval 0 success + \retval -1 failure + + On failure, use yaz_retrieval_get_error to get error string. +*/ +YAZ_EXPORT +int yaz_retrieval_configure_t(yaz_retrieval_t p, const xmlNode *node, + struct yaz_record_conv_type *types); + +#endif + /** performs retrieval request based on schema and format \param p retrieval handle \param schema record schema (SRU) / element set name (Z39.50) @@ -101,11 +121,11 @@ int yaz_retrieval_configure(yaz_retrieval_t p, const void *node); */ YAZ_EXPORT int yaz_retrieval_request(yaz_retrieval_t p, - const char *schema, int *syntax, - const char **match_schema, int **match_syntax, + const char *schema, Odr_oid *syntax, + const char **match_schema, Odr_oid **match_syntax, yaz_record_conv_t *rc, const char **backend_schema, - int **backend_syntax); + Odr_oid **backend_syntax); /** returns error string (for last error) \param p record conversion handle @@ -128,6 +148,7 @@ YAZ_END_CDECL /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab