record_conv: modify new API for conversion types

[yaz-moved-to-github.git] / include / yaz / retrieval.h

diff --git a/include/yaz/retrieval.h b/include/yaz/retrieval.h
index b2a6126..f71f32f 100644 (file)
--- a/include/yaz/retrieval.h
+++ b/include/yaz/retrieval.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2007, Index Data
+/* 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:
@@ -24,7 +24,6 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/* $Id: retrieval.h,v 1.8 2007-01-03 08:42:14 adam Exp $ */
 
 /**
  * \file retrieval.h
@@ -37,7 +36,7 @@
 #include <stddef.h>
 #include <yaz/wrbuf.h>
 #include <yaz/yconfig.h>
-
+#include <yaz/oid_util.h>
 #include <yaz/record_conv.h>
 
 YAZ_BEGIN_CDECL
@@ -55,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
-    <retrievalinfo>
-       <retrieval syntax="usmarc" name="marcxml"
-            identifier="info:srw/schema/1/marcxml-v1.1"
-            backendsyntax="xml" backendname="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 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)
@@ -102,11 +121,11 @@ int yaz_retrieval_configure(yaz_retrieval_t p, const xmlNode *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
@@ -129,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