-/*
- * 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.3 2006-05-07 14:48:24 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
#include <stddef.h>
#include <yaz/wrbuf.h>
#include <yaz/yconfig.h>
-
+#include <yaz/oid_util.h>
#include <yaz/record_conv.h>
YAZ_BEGIN_CDECL
*/
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
- <retrievalinfo>
- <retrieval syntax="usmarc" schema="marcxml"
- identifier="info:srw/schema/1/marcxml-v1.1"
- backendsyntax="xml" backendschema="dc"
- >
- <title>MARCXML</title>
- <convert>
- <marc inputformat="marc" outputformat="marcxml"
- inputcharset="marc-8"/>
- <xslt stylesheet="marcxml2mods.xsl"/>
- <xslt stylesheet="mods2dc.xsl"/>
- </convert>
+ <retrievalinfo>
+ <retrieval syntax="usmarc" name="F"/>
+ <retrieval syntax="usmarc" name="B"/>
+ <retrieval syntax="xml" name="marcxml"
+ identifier="info:srw/schema/1/marcxml-v1.1">
+ <backend syntax="usmarc" name="F">
+ <marc inputformat="marc" outputformat="marcxml"
+ inputcharset="marc-8"/>
+ </backend>
+ </retrieval>
+ <retrieval syntax="xml" name="dc">
+ <backend syntax="usmarc" name="F">
+ <marc inputformat="marc" outputformat="marcxml"
+ inputcharset="marc-8"/>
+ <xslt stylesheet="MARC21slim2DC.xsl"/>
+ </backend>
</retrieval>
- </retrievalinfo>
+ </retrievalinfo>
\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)
\retval -1 failure, use yaz_retrieval_get_error() for reason
\retval 1 schema does not match
\retval 2 syntax does not match
- \retval 3 neither schema, nor syntax matches
- \retval 4 both match but not together
+ \retval 3 both match but not together
*/
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
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
projects / yaz-moved-to-github.git / blobdiff