Gecko [ admjudic.com.br ]

Name	Size	Permission
backend.h	15.2 KB	-rw-r--r--
backtrace.h	2.08 KB	-rw-r--r--
base64.h	2.39 KB	-rw-r--r--
ccl.h	11.26 KB	-rw-r--r--
ccl_xml.h	2.73 KB	-rw-r--r--
charneg.h	3.73 KB	-rw-r--r--
comstack.h	7.06 KB	-rw-r--r--
cookie.h	2.27 KB	-rw-r--r--
copy_types.h	3.01 KB	-rw-r--r--
cql.h	14.82 KB	-rw-r--r--
daemon.h	3.53 KB	-rw-r--r--
diagbib1.h	10.14 KB	-rw-r--r--
diagsru_update.h	3.66 KB	-rw-r--r--
diagsrw.h	4.87 KB	-rw-r--r--
dirent.h	2.18 KB	-rw-r--r--
errno.h	2.24 KB	-rw-r--r--
facet.h	3.63 KB	-rw-r--r--
file_glob.h	3.16 KB	-rw-r--r--
gettimeofday.h	2.08 KB	-rw-r--r--
icu.h	7.56 KB	-rw-r--r--
ill-core.h	46.03 KB	-rw-r--r--
ill.h	2.43 KB	-rw-r--r--
item-req.h	1.87 KB	-rw-r--r--
json.h	6.66 KB	-rw-r--r--
log.h	8.4 KB	-rw-r--r--
logrpn.h	2.44 KB	-rw-r--r--
marcdisp.h	16.52 KB	-rw-r--r--
match_glob.h	2.2 KB	-rw-r--r--
matchstr.h	3.59 KB	-rw-r--r--
mutex.h	4.36 KB	-rw-r--r--
nmem.h	7.42 KB	-rw-r--r--
nmem_xml.h	2.08 KB	-rw-r--r--
oclc-ill-req-ext.h	1.63 KB	-rw-r--r--
odr.h	11.81 KB	-rw-r--r--
oid_db.h	6.25 KB	-rw-r--r--
oid_std.h	8.62 KB	-rw-r--r--
oid_util.h	3.23 KB	-rw-r--r--
options.h	3.11 KB	-rw-r--r--
otherinfo.h	2.42 KB	-rw-r--r--
poll.h	3.01 KB	-rw-r--r--
pquery.h	3.5 KB	-rw-r--r--
proto.h	8.28 KB	-rw-r--r--
prt-ext.h	6.22 KB	-rw-r--r--
query-charset.h	2.38 KB	-rw-r--r--
querytowrbuf.h	2.43 KB	-rw-r--r--
readconf.h	2.21 KB	-rw-r--r--
record_conv.h	5.41 KB	-rw-r--r--
record_render.h	2.55 KB	-rw-r--r--
retrieval.h	5.24 KB	-rw-r--r--
rpn2cql.h	3.82 KB	-rw-r--r--
rpn2solr.h	3.85 KB	-rw-r--r--
sc.h	3.35 KB	-rw-r--r--
shptr.h	3.09 KB	-rw-r--r--
snprintf.h	2.13 KB	-rw-r--r--
soap.h	3.36 KB	-rw-r--r--
solr.h	3.76 KB	-rw-r--r--
sortspec.h	4.37 KB	-rw-r--r--
spipe.h	2.64 KB	-rw-r--r--
srw.h	12.04 KB	-rw-r--r--
statserv.h	1.89 KB	-rw-r--r--
stemmer.h	2.36 KB	-rw-r--r--
tcpip.h	2.84 KB	-rw-r--r--
test.h	4.32 KB	-rw-r--r--
thread_create.h	2.65 KB	-rw-r--r--
thread_id.h	2.13 KB	-rw-r--r--
timing.h	3.21 KB	-rw-r--r--
tokenizer.h	2.71 KB	-rw-r--r--
tpath.h	4.05 KB	-rw-r--r--
unix.h	2.04 KB	-rw-r--r--
url.h	3.6 KB	-rw-r--r--
wrbuf.h	9.26 KB	-rw-r--r--
xmalloc.h	5.3 KB	-rw-r--r--
xml_get.h	2.02 KB	-rw-r--r--
xml_include.h	3.06 KB	-rw-r--r--
xmlquery.h	2.24 KB	-rw-r--r--
xmltypes.h	1.9 KB	-rw-r--r--
yaz-ccl.h	2.11 KB	-rw-r--r--
yaz-iconv.h	4.27 KB	-rw-r--r--
yaz-util.h	4.51 KB	-rw-r--r--
yaz-version.h	2.83 KB	-rw-r--r--
yconfig.h	2.28 KB	-rw-r--r--
z-accdes1.h	857 B	-rw-r--r--
z-accform1.h	3.51 KB	-rw-r--r--
z-acckrb1.h	1.1 KB	-rw-r--r--
z-charneg.h	5 KB	-rw-r--r--
z-core.h	39.23 KB	-rw-r--r--
z-date.h	2.77 KB	-rw-r--r--
z-diag1.h	8.69 KB	-rw-r--r--
z-espec1.h	3.77 KB	-rw-r--r--
z-estask.h	1.05 KB	-rw-r--r--
z-exp.h	29.88 KB	-rw-r--r--
z-facet-1.h	941 B	-rw-r--r--
z-grs.h	4.37 KB	-rw-r--r--
z-mterm2.h	877 B	-rw-r--r--
z-oclcui.h	792 B	-rw-r--r--
z-opac.h	2.85 KB	-rw-r--r--
z-rrf1.h	1.65 KB	-rw-r--r--
z-rrf2.h	820 B	-rw-r--r--
z-sum.h	1.32 KB	-rw-r--r--
z-sutrs.h	643 B	-rw-r--r--
z-uifr1.h	2.42 KB	-rw-r--r--
z-univ.h	1.19 KB	-rw-r--r--
zes-admin.h	2.95 KB	-rw-r--r--
zes-expi.h	3.02 KB	-rw-r--r--
zes-exps.h	2.72 KB	-rw-r--r--
zes-order.h	3.61 KB	-rw-r--r--
zes-pquery.h	2.26 KB	-rw-r--r--
zes-psched.h	3.46 KB	-rw-r--r--
zes-pset.h	2.01 KB	-rw-r--r--
zes-update.h	4.93 KB	-rw-r--r--
zes-update0.h	4.45 KB	-rw-r--r--
zgdu.h	4.84 KB	-rw-r--r--
zoom.h	17.9 KB	-rw-r--r--

Code Editor : retrieval.h

/* This file is part of the YAZ toolkit.
 * Copyright (C) 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:
 *
 *     * 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 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
 */

#ifndef YAZ_RETRIEVAL_H
#define YAZ_RETRIEVAL_H

#include <stddef.h>
#include <yaz/wrbuf.h>
#include <yaz/yconfig.h>
#include <yaz/oid_util.h>
#include <yaz/record_conv.h>

YAZ_BEGIN_CDECL

/** retrieval handle  */
typedef struct yaz_retrieval_struct *yaz_retrieval_t;

/** creates retrieval handle
    \return retrieval handle
*/
YAZ_EXPORT yaz_retrieval_t yaz_retrieval_create(void);

/** destroys retrieval handle
    \param p retrieval handle
*/
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, call yaz_retrieval_get_error to get error string.

For retrieval:
    \verbatim
     <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>
    \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)
    \param syntax record syntax (format)
    \param match_schema matched schema (if conversion was successful)
    \param match_syntax matced syntax OID  if conversion was successful)
    \param rc record conversion reference (if conversion was successful)
    \param backend_schema backend scchema (if conversion was successful)
    \param backend_syntax backend syntax (if conversion was successful)
    \retval 0 success, schema and syntax matches
    \retval -1 failure, use yaz_retrieval_get_error() for reason
    \retval 1 schema does not match
    \retval 2 syntax does not match
    \retval 3 both match but not together
*/
YAZ_EXPORT
int yaz_retrieval_request(yaz_retrieval_t p,
                          const char *schema, Odr_oid *syntax,
                          const char **match_schema, Odr_oid **match_syntax,
                          yaz_record_conv_t *rc,
                          const char **backend_schema,
                          Odr_oid **backend_syntax);

/** returns error string (for last error)
    \param p record conversion handle
    \return error string
*/
YAZ_EXPORT
const char *yaz_retrieval_get_error(yaz_retrieval_t p);

/** set path for opening stylesheets etc.
    \param p record conversion handle
    \param path file path (UNIX style with : / Windows with ;)
*/
YAZ_EXPORT
void yaz_retrieval_set_path(yaz_retrieval_t p, const char *path);

YAZ_END_CDECL

#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */

${this.title}

Code Editor : retrieval.h